blob: 47740e83e6a1698670d3326a3c0b7fe84fe069b1 [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-lunarg540b2252020-08-03 13:23:36 -060064std::vector<VkImageView> FRAMEBUFFER_STATE::GetUsedAttachments(const safe_VkSubpassDescription2 &subpasses) {
65 std::vector<VkImageView> attachment_views(createInfo.attachmentCount, VK_NULL_HANDLE);
66
67 for (uint32_t index = 0; index < subpasses.inputAttachmentCount; ++index) {
68 if (subpasses.pInputAttachments[index].attachment != VK_ATTACHMENT_UNUSED) {
69 attachment_views[subpasses.pInputAttachments[index].attachment] =
70 createInfo.pAttachments[subpasses.pInputAttachments[index].attachment];
71 }
72 }
73 for (uint32_t index = 0; index < subpasses.colorAttachmentCount; ++index) {
74 if (subpasses.pColorAttachments[index].attachment != VK_ATTACHMENT_UNUSED) {
75 attachment_views[subpasses.pColorAttachments[index].attachment] =
76 createInfo.pAttachments[subpasses.pColorAttachments[index].attachment];
77 }
78 if (subpasses.pResolveAttachments && subpasses.pResolveAttachments[index].attachment != VK_ATTACHMENT_UNUSED) {
79 attachment_views[subpasses.pResolveAttachments[index].attachment] =
80 createInfo.pAttachments[subpasses.pResolveAttachments[index].attachment];
81 }
82 }
83 if (subpasses.pDepthStencilAttachment && subpasses.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
84 attachment_views[subpasses.pDepthStencilAttachment->attachment] =
85 createInfo.pAttachments[subpasses.pDepthStencilAttachment->attachment];
86 }
87 return attachment_views;
88}
89
locke-lunarg296a3c92020-03-25 01:04:29 -060090IMAGE_STATE::IMAGE_STATE(VkDevice dev, VkImage img, const VkImageCreateInfo *pCreateInfo)
John Zulauff660ad62019-03-23 07:16:05 -060091 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -070092 safe_create_info(pCreateInfo),
93 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -060094 valid(false),
95 acquired(false),
96 shared_presentable(false),
97 layout_locked(false),
98 get_sparse_reqs_called(false),
99 sparse_metadata_required(false),
100 sparse_metadata_bound(false),
John Zulauff660ad62019-03-23 07:16:05 -0600101 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700102 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -0600103 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700104 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -0600105 create_from_swapchain(VK_NULL_HANDLE),
106 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -0600107 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700108 range_encoder(full_range),
sfricke-samsung71bc6572020-04-29 15:49:43 -0700109 disjoint(false),
110 plane0_memory_requirements_checked(false),
111 plane1_memory_requirements_checked(false),
112 plane2_memory_requirements_checked(false),
locke-lunarg296a3c92020-03-25 01:04:29 -0600113 subresource_encoder(full_range),
locke-lunargae26eac2020-04-16 15:29:05 -0600114 fragment_encoder(nullptr),
locke-lunarg296a3c92020-03-25 01:04:29 -0600115 store_device_as_workaround(dev), // TODO REMOVE WHEN encoder can be const
unknown08c57af2019-06-21 16:33:35 -0600116 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -0600117 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
118 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
119 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
120 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
121 }
122 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
123 }
124
125 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
126 sparse = true;
127 }
Locked8af3732019-05-10 09:47:56 -0600128
sfricke-samsunge2441192019-11-06 14:07:57 -0800129 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
130 if (externalMemoryInfo) {
131 external_memory_handle = externalMemoryInfo->handleTypes;
132 }
John Zulauff660ad62019-03-23 07:16:05 -0600133}
134
unknown2c877272019-07-11 12:56:50 -0600135bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
136 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
137 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
138 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
139 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
140 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
141 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600142 return is_equal &&
143 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600144}
145
Jeff Bolz82f854d2019-09-17 14:56:47 -0500146// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
147bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
148 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
149 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
150 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
151 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
152 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600153 is_compatible = is_compatible &&
154 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
155 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500156
157 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
158 createInfo.extent.height <= other_createInfo.extent.height &&
159 createInfo.extent.depth <= other_createInfo.extent.depth &&
160 createInfo.arrayLayers <= other_createInfo.arrayLayers;
161 return is_compatible;
162}
163
unknown2c877272019-07-11 12:56:50 -0600164bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700165 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
166 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
167 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700168 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
169 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600170 IsCreateInfoEqual(other_image_state->createInfo)) {
171 return true;
172 }
unknowne1661522019-07-11 13:04:18 -0600173 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
174 return true;
175 }
unknown2c877272019-07-11 12:56:50 -0600176 return false;
177}
178
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500179IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
180 : image_view(iv),
181 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700182 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
locke-lunarg296a3c92020-03-25 01:04:29 -0600183 range_generator(im->subresource_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500184 samplerConversion(VK_NULL_HANDLE),
185 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600186 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
187 if (conversionInfo) samplerConversion = conversionInfo->conversion;
188 if (image_state) {
189 // A light normalization of the createInfo range
190 auto &sub_res_range = create_info.subresourceRange;
191 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
192 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
193
194 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700195 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500196 samples = image_state->createInfo.samples;
197 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600198 }
199}
200
locke-lunarg540b2252020-08-03 13:23:36 -0600201bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
202 if (image_state->image != compare_view.image_state->image) {
203 return false;
204 }
205 if (image_view == compare_view.image_view) {
206 return true;
207 }
208 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
209 return false;
210 }
211
212 // compare if overlap mip level
213 if (normalized_subresource_range.baseMipLevel == compare_view.normalized_subresource_range.baseMipLevel) {
214 return true;
215 }
216
217 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
218 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) >=
219 compare_view.normalized_subresource_range.baseMipLevel)) {
220 return true;
221 }
222
223 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
224 (normalized_subresource_range.baseMipLevel <=
225 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
226 return true;
227 }
228
229 // compare if overlap array layer
230 if (normalized_subresource_range.baseArrayLayer == compare_view.normalized_subresource_range.baseArrayLayer) {
231 return true;
232 }
233
234 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
235 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) >=
236 compare_view.normalized_subresource_range.baseArrayLayer)) {
237 return true;
238 }
239
240 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
241 (normalized_subresource_range.baseArrayLayer <=
242 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
243 return true;
244 }
245 return false;
246}
247
Dave Houltond9611312018-11-19 17:03:36 -0700248uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
249 // uint cast applies floor()
250 return 1u + (uint32_t)log2(std::max({height, width, depth}));
251}
252
253uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
254
255uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
256
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500257bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700258 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700259 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700260
John Zulauf2076e812020-01-08 14:55:54 -0700261 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
262 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700263 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
264 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
265
John Zulauf2076e812020-01-08 14:55:54 -0700266 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
267
268 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
269 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700270 return false;
271 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700272
John Zulauf2076e812020-01-08 14:55:54 -0700273 for (auto entry : *layout_range_map) {
274 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700275 }
276 return true;
277}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700278
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600279// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600280void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600281 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
282 VkImageLayout expected_layout) {
283 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
284 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600285 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600286 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700287 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700288 for (const auto &image : image_state.aliasing_images) {
289 auto alias_state = GetImageState(image);
290 // The map state of the aliases should all be in sync, so no need to check the return value
291 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
292 assert(subresource_map);
293 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
294 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700295}
John Zulauff660ad62019-03-23 07:16:05 -0600296
297// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600298void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600299 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500300 return;
301 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500302 IMAGE_STATE *image_state = view_state.image_state.get();
303 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700304 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700305 for (const auto &image : image_state->aliasing_images) {
306 image_state = GetImageState(image);
307 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
308 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
309 }
John Zulauff660ad62019-03-23 07:16:05 -0600310}
311
312// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600313void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600314 const VkImageSubresourceRange &range, VkImageLayout layout) {
315 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
316 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600317 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700318 for (const auto &image : image_state.aliasing_images) {
319 auto alias_state = GetImageState(image);
320 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
321 assert(subresource_map);
322 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
323 }
John Zulauff660ad62019-03-23 07:16:05 -0600324}
325
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600326void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600327 VkImageLayout layout) {
328 const IMAGE_STATE *image_state = GetImageState(image);
329 if (!image_state) return;
330 SetImageInitialLayout(cb_node, *image_state, range, layout);
331};
332
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600333void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600334 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
335 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600336}
Dave Houltonddd65c52018-05-08 14:58:01 -0600337
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600338// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700339void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
340 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500341 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600342
John Zulauff660ad62019-03-23 07:16:05 -0600343 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600344 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
345 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600346 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 -0600347 sub_range.baseArrayLayer = 0;
348 sub_range.layerCount = image_state->createInfo.extent.depth;
349 }
350
Piers Daniell4fde9b72019-11-27 16:19:46 -0700351 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
352 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
353 SetImageLayout(cb_node, *image_state, sub_range, layout);
354 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
355 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
356 } else {
357 SetImageLayout(cb_node, *image_state, sub_range, layout);
358 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600359}
360
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700361bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
362 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700363 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600364 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100365 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700366 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100367 const char *vuid;
368 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700369 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100370
371 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600372 LogObjectList objlist(image);
373 objlist.add(renderpass);
374 objlist.add(framebuffer);
375 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700376 skip |=
377 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
378 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
379 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
380 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100381 return skip;
382 }
383
384 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200385 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
386 if (stencil_usage_info) {
387 image_usage |= stencil_usage_info->stencilUsage;
388 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100389
390 // Check for layouts that mismatch image usages in the framebuffer
391 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800392 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600393 LogObjectList objlist(image);
394 objlist.add(renderpass);
395 objlist.add(framebuffer);
396 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700397 skip |= LogError(objlist, vuid,
398 "%s: Layout/usage mismatch for attachment %u in %s"
399 " - the %s is %s but the image attached to %s via %s"
400 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
401 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
402 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
403 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100404 }
405
406 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
407 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800408 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600409 LogObjectList objlist(image);
410 objlist.add(renderpass);
411 objlist.add(framebuffer);
412 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700413 skip |= LogError(objlist, vuid,
414 "%s: Layout/usage mismatch for attachment %u in %s"
415 " - the %s is %s but the image attached to %s via %s"
416 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
417 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
418 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
419 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100420 }
421
422 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800423 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
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_TRANSFER_SRC_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_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800438 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
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_DST_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
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600452 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100453 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
454 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
455 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
456 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
457 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800458 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600459 LogObjectList objlist(image);
460 objlist.add(renderpass);
461 objlist.add(framebuffer);
462 objlist.add(image_view);
463 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700464 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700465 " - the %s is %s but the image attached to %s via %s"
466 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700467 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700468 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
469 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100470 }
471 } else {
472 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
473 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
474 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
475 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600476 LogObjectList objlist(image);
477 objlist.add(renderpass);
478 objlist.add(framebuffer);
479 objlist.add(image_view);
480 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700481 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700482 " - the %s is %s but the image attached to %s via %s"
483 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700484 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700485 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
486 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100487 }
488 }
489 return skip;
490}
491
John Zulauf17a01bb2019-08-09 16:41:19 -0600492bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700493 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600494 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600495 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700496 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700497 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100498 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100499
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700500 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100501 auto framebuffer = framebuffer_state->framebuffer;
502
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700503 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700504 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
505 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700506 }
John Zulauf8e308292018-09-21 11:34:37 -0600507
Tobias Hectorc9057422019-07-23 12:15:52 +0100508 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
509 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
510 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100511 }
512
Tobias Hectorc9057422019-07-23 12:15:52 +0100513 if (attachments != nullptr) {
514 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
515 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
516 auto image_view = attachments[i];
517 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100518
Tobias Hectorc9057422019-07-23 12:15:52 +0100519 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600520 LogObjectList objlist(pRenderPassBegin->renderPass);
521 objlist.add(framebuffer_state->framebuffer);
522 objlist.add(image_view);
523 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700524 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
525 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
526 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100527 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100528 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100529
530 const VkImage image = view_state->create_info.image;
531 const IMAGE_STATE *image_state = GetImageState(image);
532
533 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600534 LogObjectList objlist(pRenderPassBegin->renderPass);
535 objlist.add(framebuffer_state->framebuffer);
536 objlist.add(image_view);
537 objlist.add(image);
538 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700539 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
540 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
541 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100542 continue;
543 }
544 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
545 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
546
Piers Daniell7f894f62020-01-09 16:33:48 -0700547 // Default to expecting stencil in the same layout.
548 auto attachment_stencil_initial_layout = attachment_initial_layout;
549
550 // If a separate layout is specified, look for that.
551 const auto *attachment_description_stencil_layout =
552 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
553 if (attachment_description_stencil_layout) {
554 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
555 }
556
Tobias Hectorc9057422019-07-23 12:15:52 +0100557 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
558 // in common with the non-const version.)
559 const ImageSubresourceLayoutMap *subresource_map =
560 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
561
562 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
563 LayoutUseCheckAndMessage layout_check(subresource_map);
564 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700565 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
566 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
567 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700568
John Zulauf5e617452019-11-19 14:44:16 -0700569 // Allow for differing depth and stencil layouts
570 VkImageLayout check_layout = attachment_initial_layout;
571 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
572
573 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700574 subres_skip |= LogError(
575 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700576 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
577 "and the %s layout of the attachment is %s. The layouts must match, or the render "
578 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700579 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100580 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700581 }
John Zulauf5e617452019-11-19 14:44:16 -0700582
Tobias Hectorc9057422019-07-23 12:15:52 +0100583 skip |= subres_skip;
584 }
585
586 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
587 framebuffer, render_pass, i, "initial layout");
588
589 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
590 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100591 }
592
Tobias Hectorc9057422019-07-23 12:15:52 +0100593 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
594 auto &subpass = pRenderPassInfo->pSubpasses[j];
595 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
596 auto &attachment_ref = subpass.pInputAttachments[k];
597 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
598 auto image_view = attachments[attachment_ref.attachment];
599 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100600
Tobias Hectorc9057422019-07-23 12:15:52 +0100601 if (view_state) {
602 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700603 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
604 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100605 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100606 }
607 }
608 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100609
Tobias Hectorc9057422019-07-23 12:15:52 +0100610 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
611 auto &attachment_ref = subpass.pColorAttachments[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;
618 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
619 framebuffer, render_pass, attachment_ref.attachment,
620 "color attachment layout");
621 if (subpass.pResolveAttachments) {
622 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
623 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
624 attachment_ref.attachment, "resolve attachment layout");
625 }
626 }
627 }
628 }
629
630 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
631 auto &attachment_ref = *subpass.pDepthStencilAttachment;
632 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
633 auto image_view = attachments[attachment_ref.attachment];
634 auto view_state = GetImageViewState(image_view);
635
636 if (view_state) {
637 auto image = view_state->create_info.image;
638 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
639 framebuffer, render_pass, attachment_ref.attachment,
640 "input attachment layout");
641 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100642 }
643 }
644 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700645 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600646 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700647}
648
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600649void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700650 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700651 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700652 IMAGE_VIEW_STATE *image_view = nullptr;
653 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
654 const auto attachment_info =
655 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
656 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
657 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300658 image_view = GetAttachmentImageViewState(pCB, pFramebuffer, ref.attachment);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700659 }
John Zulauf8e308292018-09-21 11:34:37 -0600660 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700661 VkImageLayout stencil_layout = kInvalidLayout;
662 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
663 if (attachment_reference_stencil_layout) {
664 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
665 }
666
667 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600668 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700669 }
670}
671
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600672void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
673 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700674 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700675
676 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700677 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700678 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700679 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700680 }
681 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700682 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700683 }
684 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700685 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700686 }
687 }
688}
689
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700690// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
691// 1. Transition into initialLayout state
692// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600693void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700694 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700695 // First transition into initialLayout
696 auto const rpci = render_pass_state->createInfo.ptr();
697 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700698 IMAGE_VIEW_STATE *view_state = nullptr;
699 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
700 const auto attachment_info =
701 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
702 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
703 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300704 view_state = GetAttachmentImageViewState(cb_state, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700705 }
John Zulauf8e308292018-09-21 11:34:37 -0600706 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700707 VkImageLayout stencil_layout = kInvalidLayout;
708 const auto *attachment_description_stencil_layout =
709 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
710 if (attachment_description_stencil_layout) {
711 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
712 }
713
714 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600715 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700716 }
717 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700718 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700719}
720
Dave Houlton10b39482017-03-16 13:18:15 -0600721bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600722 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600723 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600724 }
725 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600726 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600727 }
728 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600729 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600730 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700731 if (0 !=
732 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
733 if (FormatPlaneCount(format) == 1) return false;
734 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600735 return true;
736}
737
Mike Weiblen62d08a32017-03-07 22:18:27 -0700738// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200739bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
740 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600741 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700742 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200743 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600744 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700745
746 switch (layout) {
747 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
748 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600749 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700750 }
751 break;
752 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
753 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600754 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700755 }
756 break;
757 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
758 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600759 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700760 }
761 break;
762 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
763 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600764 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700765 }
766 break;
767 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
768 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600769 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700770 }
771 break;
772 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
773 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600774 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700775 }
776 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600777 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500778 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
779 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
780 }
781 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700782 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
783 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
784 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
785 }
786 break;
787 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
788 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
789 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
790 }
791 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700792 default:
793 // Other VkImageLayout values do not have VUs defined in this context.
794 break;
795 }
796
Dave Houlton8e9f6542018-05-18 12:18:22 -0600797 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700798 skip |= LogError(img_barrier.image, msg_code,
799 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
800 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
801 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700802 }
803 return skip;
804}
805
806// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600807bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
808 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700809 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700810
Petr Krausad0096a2019-08-09 18:35:04 +0200811 // Scoreboard for checking for duplicate and inconsistent barriers to images
812 struct ImageBarrierScoreboardEntry {
813 uint32_t index;
814 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
815 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
816 const VkImageMemoryBarrier *barrier;
817 };
818 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
819 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
820
John Zulauf463c51e2018-05-31 13:29:20 -0600821 // Scoreboard for duplicate layout transition barriers within the list
822 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
823 ImageBarrierScoreboardImageMap layout_transitions;
824
Mike Weiblen62d08a32017-03-07 22:18:27 -0700825 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200826 const auto &img_barrier = pImageMemoryBarriers[i];
827 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700828
John Zulauf463c51e2018-05-31 13:29:20 -0600829 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
830 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
831 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200832 if (img_barrier.oldLayout != img_barrier.newLayout) {
833 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
834 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600835 if (image_it != layout_transitions.end()) {
836 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200837 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600838 if (subres_it != subres_map.end()) {
839 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200840 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
841 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
842 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700843 skip = LogError(
844 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200845 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600846 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
847 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200848 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
849 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
850 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600851 }
852 entry = new_entry;
853 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200854 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600855 }
856 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200857 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600858 }
859 }
860
Petr Krausad0096a2019-08-09 18:35:04 +0200861 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600862 if (image_state) {
863 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200864 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
865 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600866
867 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
868 if (image_state->layout_locked) {
869 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700870 skip |= LogError(
871 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700872 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600873 " 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 -0700874 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200875 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600876 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600877
John Zulaufa4472282019-08-22 14:44:34 -0600878 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700879 const VkFormat image_format = image_create_info.format;
880 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600881 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700882 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700883 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600884 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
885 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700886 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
887 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
888 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
889 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700890 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600891 }
892 } else {
893 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
894 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -0700895 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
896 ? "VUID-VkImageMemoryBarrier-image-03320"
897 : "VUID-VkImageMemoryBarrier-image-01207";
898 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700899 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
900 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
901 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700902 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600903 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700904 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700905 }
John Zulauff660ad62019-03-23 07:16:05 -0600906
Petr Krausad0096a2019-08-09 18:35:04 +0200907 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
908 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600909 // TODO: Set memory invalid which is in mem_tracker currently
910 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
911 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600912 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600913 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600914 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200915 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700916 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
917 const auto &value = *pos;
918 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700919 subres_skip = LogError(
920 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700921 "%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 -0700922 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700923 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -0700924 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
925 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600926 }
John Zulauf5e617452019-11-19 14:44:16 -0700927 }
John Zulauff660ad62019-03-23 07:16:05 -0600928 skip |= subres_skip;
929 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700930
931 // checks color format and (single-plane or non-disjoint)
932 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
933 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700934 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700935 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
936 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
937 ? "VUID-VkImageMemoryBarrier-image-01671"
938 : "VUID-VkImageMemoryBarrier-image-02902";
939 skip |= LogError(img_barrier.image, vuid,
940 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
941 "but its aspectMask is 0x%" PRIx32 ".",
942 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
943 string_VkFormat(image_format), aspect_mask);
944 }
945 }
946
947 VkImageAspectFlags valid_disjoint_mask =
948 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 -0700949 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700950 ((aspect_mask & valid_disjoint_mask) == 0)) {
951 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
952 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
953 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
954 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
955 string_VkFormat(image_format), aspect_mask);
956 }
957
958 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
959 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
960 "%s: Image barrier %s references %s of format %s has only two planes but included "
961 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
962 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
963 string_VkFormat(image_format), aspect_mask);
964 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700965 }
966 }
967 return skip;
968}
969
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600970bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200971 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700972
Jeff Bolz6835fda2019-10-06 00:15:34 -0500973 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200974 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700975}
976
John Zulauf6b4aae82018-05-09 13:03:36 -0600977template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600978bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
979 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600980 using BarrierRecord = QFOTransferBarrier<Barrier>;
981 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500982 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600983 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
984 const char *barrier_name = BarrierRecord::BarrierName();
985 const char *handle_name = BarrierRecord::HandleName();
986 const char *transfer_type = nullptr;
987 for (uint32_t b = 0; b < barrier_count; b++) {
988 if (!IsTransferOp(&barriers[b])) continue;
989 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700990 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600991 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600992 const auto found = barrier_sets.release.find(barriers[b]);
993 if (found != barrier_sets.release.cend()) {
994 barrier_record = &(*found);
995 transfer_type = "releasing";
996 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600997 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600998 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600999 const auto found = barrier_sets.acquire.find(barriers[b]);
1000 if (found != barrier_sets.acquire.cend()) {
1001 barrier_record = &(*found);
1002 transfer_type = "acquiring";
1003 }
1004 }
1005 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001006 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
1007 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1008 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
1009 func_name, barrier_name, b, transfer_type, handle_name,
1010 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
1011 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001012 }
1013 }
1014 return skip;
1015}
1016
John Zulaufa4472282019-08-22 14:44:34 -06001017VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1018 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1019}
1020
1021const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1022 return device_state.GetImageState(barrier.image);
1023}
1024
1025VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1026 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1027}
1028
1029const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1030 return device_state.GetBufferState(barrier.buffer);
1031}
1032
1033VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1034
John Zulauf6b4aae82018-05-09 13:03:36 -06001035template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001036void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1037 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001038 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001039 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1040 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001041 auto &barrier = barriers[b];
1042 if (IsTransferOp(&barrier)) {
1043 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001044 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001045 barrier_sets.release.emplace(barrier);
1046 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001047 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001048 barrier_sets.acquire.emplace(barrier);
1049 }
1050 }
1051
1052 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1053 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1054 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1055 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1056 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1057 auto handle_state = BarrierHandleState(*this, barrier);
1058 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1059 if (!mode_concurrent) {
1060 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001061 cb_state->queue_submit_functions.emplace_back(
1062 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1063 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1064 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1065 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001066 });
1067 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001068 }
1069 }
1070}
1071
John Zulaufa4472282019-08-22 14:44:34 -06001072bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001073 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001074 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001075 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001076 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001077 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1078 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001079 return skip;
1080}
1081
John Zulaufa4472282019-08-22 14:44:34 -06001082void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1083 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1084 const VkImageMemoryBarrier *pImageMemBarriers) {
1085 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1086 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001087}
1088
1089template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001090bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001091 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001092 // Record to the scoreboard or report that we have a duplication
1093 bool skip = false;
1094 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1095 if (!inserted.second && inserted.first->second != cb_state) {
1096 // 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 -06001097 LogObjectList objlist(cb_state->commandBuffer);
1098 objlist.add(barrier.handle);
1099 objlist.add(inserted.first->second->commandBuffer);
1100 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001101 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1102 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1103 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1104 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1105 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001106 }
1107 return skip;
1108}
1109
1110template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001111bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1112 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001113 using BarrierRecord = QFOTransferBarrier<Barrier>;
1114 using TypeTag = typename BarrierRecord::Tag;
1115 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001116 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001117 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001118 const char *barrier_name = BarrierRecord::BarrierName();
1119 const char *handle_name = BarrierRecord::HandleName();
1120 // No release should have an extant duplicate (WARNING)
1121 for (const auto &release : cb_barriers.release) {
1122 // Check the global pending release barriers
1123 const auto set_it = global_release_barriers.find(release.handle);
1124 if (set_it != global_release_barriers.cend()) {
1125 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1126 const auto found = set_for_handle.find(release);
1127 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001128 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1129 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1130 " to dstQueueFamilyIndex %" PRIu32
1131 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1132 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1133 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001134 }
1135 }
1136 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1137 }
1138 // Each acquire must have a matching release (ERROR)
1139 for (const auto &acquire : cb_barriers.acquire) {
1140 const auto set_it = global_release_barriers.find(acquire.handle);
1141 bool matching_release_found = false;
1142 if (set_it != global_release_barriers.cend()) {
1143 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1144 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1145 }
1146 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001147 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1148 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1149 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1150 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1151 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001152 }
1153 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1154 }
1155 return skip;
1156}
1157
John Zulauf3b04ebd2019-07-18 14:08:11 -06001158bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001159 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001160 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001161 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001162 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1163 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001164 return skip;
1165}
1166
1167template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001168void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001169 using BarrierRecord = QFOTransferBarrier<Barrier>;
1170 using TypeTag = typename BarrierRecord::Tag;
1171 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001172 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001173
1174 // Add release barriers from this submit to the global map
1175 for (const auto &release : cb_barriers.release) {
1176 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1177 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1178 global_release_barriers[release.handle].insert(release);
1179 }
1180
1181 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1182 for (const auto &acquire : cb_barriers.acquire) {
1183 // NOTE: We're not using [] because we don't want to create entries for missing releases
1184 auto set_it = global_release_barriers.find(acquire.handle);
1185 if (set_it != global_release_barriers.end()) {
1186 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1187 set_for_handle.erase(acquire);
1188 if (set_for_handle.size() == 0) { // Clean up empty sets
1189 global_release_barriers.erase(set_it);
1190 }
1191 }
1192 }
1193}
1194
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001195void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001196 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1197 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001198}
1199
John Zulauf6b4aae82018-05-09 13:03:36 -06001200// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001201void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001202
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001203void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001204 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001205 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001206 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001207
Chris Forbes4de4b132017-08-21 11:27:08 -07001208 // For ownership transfers, the barrier is specified twice; as a release
1209 // operation on the yielding queue family, and as an acquire operation
1210 // on the acquiring queue family. This barrier may also include a layout
1211 // transition, which occurs 'between' the two operations. For validation
1212 // purposes it doesn't seem important which side performs the layout
1213 // transition, but it must not be performed twice. We'll arbitrarily
1214 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001215 //
1216 // However, we still need to record initial layout for the "initial layout" validation
1217 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001218
Petr Krausad0096a2019-08-09 18:35:04 +02001219 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001220 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001221 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001222 }
1223}
1224
unknown86bcb3a2019-07-11 13:05:36 -06001225void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001226 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001227 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1228 const auto &image_create_info = image_state->createInfo;
1229
1230 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1231 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1232 // for all (potential) layer sub_resources.
1233 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1234 normalized_isr.baseArrayLayer = 0;
1235 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1236 }
1237
Michael Spang8af7c102020-05-03 20:50:09 -04001238 VkImageLayout initial_layout = mem_barrier.oldLayout;
1239
1240 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001241 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001242 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1243 }
1244
John Zulauf2be3fe02019-12-30 09:48:02 -07001245 if (is_release_op) {
1246 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1247 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001248 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001249 }
unknown86bcb3a2019-07-11 13:05:36 -06001250}
1251
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001252bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1253 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1254 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1255 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001256 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001257 assert(cb_node);
1258 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001259 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001260 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001261
John Zulauff660ad62019-03-23 07:16:05 -06001262 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1263 if (subresource_map) {
1264 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001265 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001266 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1267 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001268 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001269 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1270 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1271 "%s layout %s.",
1272 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1273 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1274 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001275 }
John Zulauf5e617452019-11-19 14:44:16 -07001276 }
John Zulauff660ad62019-03-23 07:16:05 -06001277 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001278 }
John Zulauff660ad62019-03-23 07:16:05 -06001279
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001280 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1281 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1282 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001283 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1284 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001285 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1286 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1287 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001288 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001289 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001290 if (image_state->shared_presentable) {
1291 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001292 skip |=
1293 LogError(device, layout_invalid_msg_code,
1294 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1295 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001296 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001297 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001298 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001299 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001300 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1301 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1302 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1303 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001304 }
1305 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001306 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001307}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001308bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001309 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1310 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001311 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001312 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1313 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1314}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001315
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001316void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001317 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001318 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001319 if (!renderPass) return;
1320
Tobias Hectorbbb12282018-10-22 15:17:59 +01001321 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001322 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001323 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001324 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001325 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1326 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1327 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1328 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001329 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001330 }
John Zulauf8e308292018-09-21 11:34:37 -06001331 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001332 VkImageLayout stencil_layout = kInvalidLayout;
1333 const auto *attachment_description_stencil_layout =
1334 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1335 if (attachment_description_stencil_layout) {
1336 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1337 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001338 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001339 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001340 }
1341 }
1342}
Dave Houltone19e20d2018-02-02 16:32:41 -07001343
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001344#ifdef VK_USE_PLATFORM_ANDROID_KHR
1345// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1346// This could also move into a seperate core_validation_android.cpp file... ?
1347
1348//
1349// AHB-specific validation within non-AHB APIs
1350//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001351bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001352 bool skip = false;
1353
1354 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1355 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001356 if (0 != ext_fmt_android->externalFormat) {
1357 if (VK_FORMAT_UNDEFINED != create_info->format) {
1358 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001359 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1360 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1361 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001362 }
1363
1364 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001365 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1366 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1367 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001368 }
1369
1370 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001371 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1372 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001373 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1374 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1375 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001376 }
1377
1378 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001379 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1380 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1381 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001382 }
1383 }
1384
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001385 if ((0 != ext_fmt_android->externalFormat) &&
1386 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001387 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001388 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1389 ") which has "
1390 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1391 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001392 }
1393 }
1394
Dave Houltond9611312018-11-19 17:03:36 -07001395 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001396 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001397 skip |=
1398 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1399 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1400 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001401 }
1402 }
1403
1404 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1405 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1406 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001407 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001408 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1409 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1410 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1411 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001412 }
1413
1414 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001415 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1416 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1417 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1418 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1419 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001420 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001421 }
1422
1423 return skip;
1424}
1425
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001426bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001427 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001428 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001429
1430 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001431 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001432 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1433 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001434 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001435 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001436 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001437
Dave Houltond9611312018-11-19 17:03:36 -07001438 // Chain must include a compatible ycbcr conversion
1439 bool conv_found = false;
1440 uint64_t external_format = 0;
1441 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1442 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001443 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001444 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001445 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001446 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001447 }
Dave Houltond9611312018-11-19 17:03:36 -07001448 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001449 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001450 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001451 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1452 "an externalFormat (%" PRIu64
1453 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1454 "with the same external format.",
1455 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001456 }
1457
1458 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001459 if (IsIdentitySwizzle(create_info->components) == false) {
1460 skip |= LogError(
1461 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1462 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1463 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1464 "= %s.",
1465 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1466 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001467 }
1468 }
Dave Houltond9611312018-11-19 17:03:36 -07001469
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001470 return skip;
1471}
1472
John Zulaufa26d3c82019-08-14 16:09:08 -06001473bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001474 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001475
John Zulaufa26d3c82019-08-14 16:09:08 -06001476 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001477 if (image_state != nullptr) {
1478 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1479 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1480 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1481 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1482 "bound to memory.");
1483 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001484 }
1485 return skip;
1486}
1487
1488#else
1489
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001490bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001491 return false;
1492}
1493
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001494bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001495
John Zulaufa26d3c82019-08-14 16:09:08 -06001496bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001497
1498#endif // VK_USE_PLATFORM_ANDROID_KHR
1499
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001500bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1501 bool skip = false;
1502
1503 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1504 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1505 const VkImageTiling image_tiling = pCreateInfo->tiling;
1506 const VkFormat image_format = pCreateInfo->format;
1507
1508 if (image_format == VK_FORMAT_UNDEFINED) {
1509 // VU 01975 states format can't be undefined unless an android externalFormat
1510#ifdef VK_USE_PLATFORM_ANDROID_KHR
1511 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1512 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1513 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1514 if (it != ahb_ext_formats_map.end()) {
1515 tiling_features = it->second;
1516 }
1517 }
1518#endif
1519 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1520 uint64_t drm_format_modifier = 0;
1521 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1522 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1523 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1524 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1525
1526 if (drm_explicit != nullptr) {
1527 drm_format_modifier = drm_explicit->drmFormatModifier;
1528 } else {
1529 // VUID 02261 makes sure its only explict or implict in parameter checking
1530 assert(drm_implicit != nullptr);
1531 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1532 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1533 }
1534 }
1535
1536 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1537 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1538 nullptr};
1539 format_properties_2.pNext = (void *)&drm_properties_list;
1540 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001541 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1542 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1543 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1544 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001545
1546 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1547 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1548 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1549 }
1550 }
1551 } else {
1552 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1553 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1554 : format_properties.optimalTilingFeatures;
1555 }
1556
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001557 // Lack of disjoint format feature support while using the flag
1558 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1559 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1560 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1561 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1562 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1563 string_VkFormat(pCreateInfo->format));
1564 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001565
1566 return skip;
1567}
1568
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001569bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001570 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001571 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001572
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001573 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001574 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001575 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1576 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001577 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1578 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001579 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001580 }
1581
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001582 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1583 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001584 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1585 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1586 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001587 }
1588
1589 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001590 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1591 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1592 "height (%d) and arrayLayers (%d) must be >= 6.",
1593 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001594 }
Dave Houlton130c0212018-01-29 13:39:56 -07001595 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001596
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001597 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001598 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1599 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1600 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001601 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1602 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1603 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001604 }
1605
1606 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001607 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1608 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1609 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001610 }
1611
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001612 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
ByumjinConffx991b6062019-08-14 15:17:53 -07001613 uint32_t ceiling_width =
1614 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1615 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1616 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1617 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001618 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1619 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1620 "ceiling of device "
1621 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1622 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1623 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001624 }
1625
1626 uint32_t ceiling_height =
1627 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1628 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1629 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1630 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001631 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1632 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1633 "ceiling of device "
1634 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1635 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1636 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001637 }
1638 }
1639
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001640 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001641 VkResult result = VK_SUCCESS;
1642 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1643 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1644 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1645 &format_limits);
1646 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001647 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1648 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1649 if (modifier_list) {
1650 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1651 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1652 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1653 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1654 image_format_info.type = pCreateInfo->imageType;
1655 image_format_info.format = pCreateInfo->format;
1656 image_format_info.tiling = pCreateInfo->tiling;
1657 image_format_info.usage = pCreateInfo->usage;
1658 image_format_info.flags = pCreateInfo->flags;
1659 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1660
1661 result =
1662 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1663 format_limits = image_format_properties.imageFormatProperties;
1664
1665 /* The application gives a list of modifier and the driver
1666 * selects one. If one is wrong, stop there.
1667 */
1668 if (result != VK_SUCCESS) break;
1669 }
1670 } else if (explicit_modifier) {
1671 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1672 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1673 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1674 image_format_info.type = pCreateInfo->imageType;
1675 image_format_info.format = pCreateInfo->format;
1676 image_format_info.tiling = pCreateInfo->tiling;
1677 image_format_info.usage = pCreateInfo->usage;
1678 image_format_info.flags = pCreateInfo->flags;
1679 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1680
1681 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1682 format_limits = image_format_properties.imageFormatProperties;
1683 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001684 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001685
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001686 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1687 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1688 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1689 if (result != VK_SUCCESS) {
1690 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001691#ifdef VK_USE_PLATFORM_ANDROID_KHR
1692 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1693#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001694 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001695 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001696 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1697 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001698 } else {
1699 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1700 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001701 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1702 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1703 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001704 }
Dave Houlton130c0212018-01-29 13:39:56 -07001705
Dave Houltona585d132019-01-18 13:05:42 -07001706 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1707 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1708 (uint64_t)pCreateInfo->samples;
1709 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001710
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001711 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001712 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001713 uint64_t ig_mask = imageGranularity - 1;
1714 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001715
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001716 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001717 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1718 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1719 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1720 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001721 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001722
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001723 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001724 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1725 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1726 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001727 }
1728
1729 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001730 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1731 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1732 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001733 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001734
1735 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1736 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1737 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1738 pCreateInfo->extent.width, format_limits.maxExtent.width);
1739 }
1740
1741 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1742 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1743 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1744 pCreateInfo->extent.height, format_limits.maxExtent.height);
1745 }
1746
1747 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1748 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1749 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1750 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1751 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001752 }
1753
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001754 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001755 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1756 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1757 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1758 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001759 skip |= LogError(device, error_vuid,
1760 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1761 "YCbCr Conversion format, arrayLayers must be 1",
1762 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001763 }
1764
1765 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001766 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1767 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1768 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001769 }
1770
1771 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001772 skip |= LogError(
1773 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001774 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1775 string_VkSampleCountFlagBits(pCreateInfo->samples));
1776 }
1777
1778 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001779 skip |= LogError(
1780 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001781 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1782 string_VkImageType(pCreateInfo->imageType));
1783 }
1784 }
1785
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001786 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001787 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001788 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001789 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001790 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1791 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1792 "format must be block, ETC or ASTC compressed, but is %s",
1793 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001794 }
1795 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001796 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1797 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1798 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001799 }
1800 }
1801 }
1802
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001803 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001804 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1805 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
1806 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001807 }
1808
unknown2c877272019-07-11 12:56:50 -06001809 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1810 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1811 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001812 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1813 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1814 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001815 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001816
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001817 const auto swapchain_create_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1818 if (swapchain_create_info != nullptr) {
1819 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1820 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1821 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1822
1823 // Validate rest of Swapchain Image create check that require swapchain state
1824 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1825 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1826 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1827 skip |= LogError(
1828 device, vuid,
1829 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1830 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1831 }
1832 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1833 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1834 skip |= LogError(device, vuid,
1835 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1836 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1837 }
1838 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR);
1839 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1840 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1841 skip |= LogError(device, vuid,
1842 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1843 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
1844 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR flags both set.");
1845 }
1846 }
1847 }
1848
sfricke-samsungedce77a2020-07-03 22:35:13 -07001849 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1850 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1851 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1852 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1853 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1854 }
1855 const VkImageCreateFlags invalid_flags =
1856 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1857 if ((pCreateInfo->flags & invalid_flags) != 0) {
1858 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1859 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1860 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1861 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1862 }
1863 }
1864
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001865 skip |= ValidateImageFormatFeatures(pCreateInfo);
1866
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001867 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001868}
1869
John Zulauf7eeb6f72019-06-17 11:56:36 -06001870void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1871 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1872 if (VK_SUCCESS != result) return;
1873
1874 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001875 auto image_state = Get<IMAGE_STATE>(*pImage);
1876 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001877}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001878
Jeff Bolz5c801d12019-10-09 10:38:45 -05001879bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001880 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001881 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001882 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001883 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001884 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001885 }
1886 return skip;
1887}
1888
John Zulauf7eeb6f72019-06-17 11:56:36 -06001889void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1890 // Clean up validation specific data
1891 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001892
locke-lunargcba7d5f2019-12-30 16:59:11 -07001893 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001894
1895 // Clean up generic image state
1896 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001897}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001898
sfricke-samsungcd924d92020-05-20 23:51:17 -07001899bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
1900 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001901 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07001902 const VkImage image = image_state->image;
1903 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001904
1905 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001906 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
1907 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001908 }
1909
sfricke-samsungcd924d92020-05-20 23:51:17 -07001910 if (FormatIsDepthOrStencil(format)) {
1911 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1912 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
1913 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
1914 } else if (FormatIsCompressed(format)) {
1915 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1916 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
1917 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001918 }
1919
1920 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001921 skip |=
1922 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
1923 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
1924 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001925 }
1926 return skip;
1927}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001928
John Zulauf07288512019-07-05 11:09:50 -06001929bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1930 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1931 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001932 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001933 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1934 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001935 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1936 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1937 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001938 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001939
1940 } else {
1941 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1942 if (!device_extensions.vk_khr_shared_presentable_image) {
1943 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001944 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1945 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1946 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001947 }
1948 } else {
1949 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1950 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001951 skip |= LogError(
1952 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001953 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1954 func_name, string_VkImageLayout(dest_image_layout));
1955 }
1956 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001957 }
1958
John Zulauff660ad62019-03-23 07:16:05 -06001959 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001960 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001961 if (subresource_map) {
1962 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001963 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001964 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001965 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1966 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001967 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1968 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1969 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1970 } else {
1971 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001972 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001973 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1974 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1975 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1976 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001977 }
John Zulauf5e617452019-11-19 14:44:16 -07001978 }
John Zulauff660ad62019-03-23 07:16:05 -06001979 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001980 }
1981
1982 return skip;
1983}
1984
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001985bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1986 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001987 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001988 bool skip = false;
1989 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001990 const auto *cb_node = GetCBState(commandBuffer);
1991 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001992 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001993 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001994 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001995 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001996 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001997 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001998 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1999 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002000 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002001 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002002 skip |=
2003 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2004 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2005 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002006 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002007 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002008 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002009 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002010 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002011 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002012 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2013 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2014 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2015 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2016 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2017 string_VkFormat(image_state->createInfo.format));
2018 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002019 }
2020 return skip;
2021}
2022
John Zulaufeabb4462019-07-05 14:13:03 -06002023void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2024 const VkClearColorValue *pColor, uint32_t rangeCount,
2025 const VkImageSubresourceRange *pRanges) {
2026 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2027
2028 auto cb_node = GetCBState(commandBuffer);
2029 auto image_state = GetImageState(image);
2030 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002031 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002032 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002033 }
2034 }
2035}
2036
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002037bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2038 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002039 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002040 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002041
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002042 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002043 const auto *cb_node = GetCBState(commandBuffer);
2044 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002045 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002046 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002047 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002048 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002049 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002050 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002051 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002052 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002053 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002054 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002055 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002056 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002057 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2058 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2059 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2060 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002061
2062 bool any_include_aspect_depth_bit = false;
2063 bool any_include_aspect_stencil_bit = false;
2064
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002065 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002066 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002067 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002068 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002069 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002070 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2071 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002072 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2073 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2074 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2075 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002076 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002077 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2078 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002079 if (FormatHasDepth(image_format) == false) {
2080 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2081 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2082 "doesn't have a depth component.",
2083 i, string_VkFormat(image_format));
2084 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002085 }
2086 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2087 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002088 if (FormatHasStencil(image_format) == false) {
2089 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2090 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2091 "%s doesn't have a stencil component.",
2092 i, string_VkFormat(image_format));
2093 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002094 }
2095 }
2096 if (any_include_aspect_stencil_bit) {
2097 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2098 if (image_stencil_struct != nullptr) {
2099 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2100 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002101 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2102 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2103 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2104 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002105 }
2106 } else {
2107 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002108 skip |= LogError(
2109 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002110 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2111 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2112 "in VkImageCreateInfo::usage used to create image");
2113 }
2114 }
2115 }
2116 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002117 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2118 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2119 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002120 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002121 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002122 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2123 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002124 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002125 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002126 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002127 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2128 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2129 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2130 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002131 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002132 }
2133 return skip;
2134}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002135
John Zulaufeabb4462019-07-05 14:13:03 -06002136void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2137 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2138 const VkImageSubresourceRange *pRanges) {
2139 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2140 auto cb_node = GetCBState(commandBuffer);
2141 auto image_state = GetImageState(image);
2142 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002143 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002144 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002145 }
2146 }
2147}
2148
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002149// Returns true if [x, xoffset] and [y, yoffset] overlap
2150static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2151 bool result = false;
2152 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2153 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2154
2155 if (intersection_max > intersection_min) {
2156 result = true;
2157 }
2158 return result;
2159}
2160
Dave Houltonc991cc92018-03-06 11:08:51 -07002161// Returns true if source area of first copy region intersects dest area of second region
2162// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2163static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002164 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002165
Dave Houltonc991cc92018-03-06 11:08:51 -07002166 // Separate planes within a multiplane image cannot intersect
2167 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002168 return result;
2169 }
2170
Dave Houltonc991cc92018-03-06 11:08:51 -07002171 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2172 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2173 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002174 result = true;
2175 switch (type) {
2176 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002177 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002178 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002179 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002180 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002181 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002182 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002183 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002184 break;
2185 default:
2186 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2187 assert(false);
2188 }
2189 }
2190 return result;
2191}
2192
Dave Houltonfc1a4052017-04-27 14:32:45 -06002193// Returns non-zero if offset and extent exceed image extents
2194static const uint32_t x_bit = 1;
2195static const uint32_t y_bit = 2;
2196static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002197static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002198 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002199 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002200 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2201 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002202 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002203 }
2204 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2205 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002206 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002207 }
2208 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2209 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002210 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002211 }
2212 return result;
2213}
2214
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002215// Test if two VkExtent3D structs are equivalent
2216static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2217 bool result = true;
2218 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2219 (extent->depth != other_extent->depth)) {
2220 result = false;
2221 }
2222 return result;
2223}
2224
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002225// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002226static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002227 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2228}
2229
2230// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002231VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002232 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2233 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002234 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002235 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002236 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002237 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002238 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002239 granularity.width *= block_size.width;
2240 granularity.height *= block_size.height;
2241 }
2242 }
2243 return granularity;
2244}
2245
2246// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2247static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2248 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002249 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2250 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002251 valid = false;
2252 }
2253 return valid;
2254}
2255
2256// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002257bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002258 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002259 bool skip = false;
2260 VkExtent3D offset_extent = {};
2261 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2262 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2263 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002264 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002265 // 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 -07002266 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002267 skip |= LogError(cb_node->commandBuffer, vuid,
2268 "%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 "
2269 "image transfer granularity is (w=0, h=0, d=0).",
2270 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002271 }
2272 } else {
2273 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2274 // integer multiples of the image transfer granularity.
2275 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002276 skip |= LogError(cb_node->commandBuffer, vuid,
2277 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2278 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2279 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2280 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002281 }
2282 }
2283 return skip;
2284}
2285
2286// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002287bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002288 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002289 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002290 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002291 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002292 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2293 // subresource extent.
2294 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002295 skip |= LogError(cb_node->commandBuffer, vuid,
2296 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2297 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2298 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2299 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002300 }
2301 } else {
2302 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2303 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2304 // subresource extent dimensions.
2305 VkExtent3D offset_extent_sum = {};
2306 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2307 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2308 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002309 bool x_ok = true;
2310 bool y_ok = true;
2311 bool z_ok = true;
2312 switch (image_type) {
2313 case VK_IMAGE_TYPE_3D:
2314 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2315 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002316 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002317 case VK_IMAGE_TYPE_2D:
2318 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2319 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002320 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002321 case VK_IMAGE_TYPE_1D:
2322 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2323 (subresource_extent->width == offset_extent_sum.width));
2324 break;
2325 default:
2326 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2327 assert(false);
2328 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002329 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002330 skip |=
2331 LogError(cb_node->commandBuffer, vuid,
2332 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2333 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2334 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2335 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2336 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2337 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002338 }
2339 }
2340 return skip;
2341}
2342
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002343bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002344 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002345 bool skip = false;
2346 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002347 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2348 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002349 }
2350 return skip;
2351}
2352
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002353bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002354 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002355 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002356 bool skip = false;
2357 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2358 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002359 skip |= LogError(cb_node->commandBuffer, vuid,
2360 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2361 "%u, but provided %s has %u array layers.",
2362 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2363 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002364 }
2365 return skip;
2366}
2367
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002368// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002369bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002370 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002371 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002372 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002373 VkExtent3D granularity = GetScaledItg(cb_node, img);
2374 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002375 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002376 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002377 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002378 return skip;
2379}
2380
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002381// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002382bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002383 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002384 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002385 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002386 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002387 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2388 skip |=
2389 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002390 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002391 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002392 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2393 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002394
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002395 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002396 granularity = GetScaledItg(cb_node, dst_img);
2397 skip |=
2398 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002399 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002400 const VkExtent3D dest_effective_extent =
2401 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002402 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002403 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002404 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002405 return skip;
2406}
2407
Dave Houlton6f9059e2017-05-02 17:15:13 -06002408// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002409bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002410 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002411 bool skip = false;
2412
2413 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002414 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002415
2416 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002417 const VkExtent3D src_copy_extent = region.extent;
2418 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002419 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2420
Dave Houlton6f9059e2017-05-02 17:15:13 -06002421 bool slice_override = false;
2422 uint32_t depth_slices = 0;
2423
2424 // Special case for copying between a 1D/2D array and a 3D image
2425 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2426 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002427 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002428 slice_override = (depth_slices != 1);
2429 } 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 -07002430 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002431 slice_override = (depth_slices != 1);
2432 }
2433
2434 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002435 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002436 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002437 skip |=
2438 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2439 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2440 "be 0 and 1, respectively.",
2441 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002442 }
2443 }
2444
Dave Houlton533be9f2018-03-26 17:08:30 -06002445 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002446 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2447 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2448 "these must be 0 and 1, respectively.",
2449 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002450 }
2451
Dave Houlton533be9f2018-03-26 17:08:30 -06002452 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002453 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2454 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2455 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002456 }
2457
Dave Houltonc991cc92018-03-06 11:08:51 -07002458 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002459 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002460 if (FormatIsCompressed(src_state->createInfo.format) ||
2461 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002462 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002463 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002464 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2465 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2466 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002467 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002468 skip |= LogError(src_state->image, vuid,
2469 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2470 "texel width & height (%d, %d).",
2471 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002472 }
2473
Dave Houlton94a00372017-12-14 15:08:47 -07002474 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002475 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2476 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002477 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002478 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002479 LogError(src_state->image, vuid,
2480 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2481 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2482 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002483 }
2484
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002485 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002486 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2487 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002488 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002489 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002490 LogError(src_state->image, vuid,
2491 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2492 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2493 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002494 }
2495
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002496 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002497 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2498 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002499 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002500 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002501 LogError(src_state->image, vuid,
2502 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2503 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2504 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002505 }
2506 } // Compressed
2507
2508 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002509 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002510 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002511 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2512 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2513 "these must be 0 and 1, respectively.",
2514 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002515 }
2516 }
2517
Dave Houlton533be9f2018-03-26 17:08:30 -06002518 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 -07002519 skip |=
2520 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2521 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2522 "and 1, respectively.",
2523 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002524 }
2525
Dave Houlton533be9f2018-03-26 17:08:30 -06002526 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002527 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2528 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2529 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002530 }
2531
sfricke-samsung30b094c2020-05-30 11:42:11 -07002532 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002533 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002534 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2535 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
2536 skip |=
2537 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2538 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2539 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2540 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2541 }
2542 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002543 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002544 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002545 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002546 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2547 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2548 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2549 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002550 }
2551 }
2552 } else { // Pre maint 1
2553 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002554 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
2555 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00139",
2556 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2557 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2558 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2559 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2560 }
Dave Houltonee281a52017-12-08 13:51:02 -07002561 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002562 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00139",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002563 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2564 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2565 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2566 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002567 }
2568 }
2569 }
2570
Dave Houltonc991cc92018-03-06 11:08:51 -07002571 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2572 if (FormatIsCompressed(dst_state->createInfo.format) ||
2573 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002574 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002575
2576 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002577 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2578 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2579 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002580 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002581 skip |= LogError(dst_state->image, vuid,
2582 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2583 "texel width & height (%d, %d).",
2584 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002585 }
2586
Dave Houlton94a00372017-12-14 15:08:47 -07002587 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002588 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2589 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002590 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002591 skip |= LogError(
2592 dst_state->image, vuid,
2593 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2594 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2595 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002596 }
2597
Dave Houltonee281a52017-12-08 13:51:02 -07002598 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2599 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2600 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002601 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002602 skip |= LogError(dst_state->image, vuid,
2603 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2604 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2605 "height (%d).",
2606 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002607 }
2608
Dave Houltonee281a52017-12-08 13:51:02 -07002609 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2610 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2611 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002612 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002613 skip |= LogError(
2614 dst_state->image, vuid,
2615 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2616 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2617 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002618 }
2619 } // Compressed
2620 }
2621 return skip;
2622}
2623
Dave Houltonc991cc92018-03-06 11:08:51 -07002624// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002625bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002626 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002627 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002628
2629 // Neither image is multiplane
2630 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2631 // If neither image is multi-plane the aspectMask member of src and dst must match
2632 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2633 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002634 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002635 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002636 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002637 }
2638 } else {
2639 // Source image multiplane checks
2640 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2641 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2642 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2643 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002644 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002645 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002646 }
2647 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2648 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2649 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002650 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002651 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002652 }
2653 // Single-plane to multi-plane
2654 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2655 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2656 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002657 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002658 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002659 }
2660
2661 // Dest image multiplane checks
2662 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2663 aspect = region.dstSubresource.aspectMask;
2664 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2665 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002666 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002667 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002668 }
2669 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2670 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2671 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002672 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002673 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002674 }
2675 // Multi-plane to single-plane
2676 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2677 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2678 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002679 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002680 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002681 }
2682 }
2683
2684 return skip;
2685}
2686
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002687bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2688 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002689 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002690 const auto *cb_node = GetCBState(commandBuffer);
2691 const auto *src_image_state = GetImageState(srcImage);
2692 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002693 const VkFormat src_format = src_image_state->createInfo.format;
2694 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002695 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002696
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002697 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002698
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002699 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2700
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002701 for (uint32_t i = 0; i < regionCount; i++) {
2702 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002703
2704 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2705 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002706 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002707
Dave Houlton6f9059e2017-05-02 17:15:13 -06002708 bool slice_override = false;
2709 uint32_t depth_slices = 0;
2710
2711 // Special case for copying between a 1D/2D array and a 3D image
2712 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2713 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2714 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002715 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002716 slice_override = (depth_slices != 1);
2717 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2718 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002719 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002720 slice_override = (depth_slices != 1);
2721 }
2722
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002723 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2724 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2725 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002726 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002727 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002728 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002729 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002730 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2731 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002732 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002733 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2734 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002735
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002736 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002737 // No chance of mismatch if we're overriding depth slice count
2738 if (!slice_override) {
2739 // The number of depth slices in srcSubresource and dstSubresource must match
2740 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2741 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002742 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2743 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002744 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002745 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2746 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002747 if (src_slices != dst_slices) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002748 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140",
2749 "vkCmdCopyImage(): number of depth slices in source and destination subresources for "
2750 "pRegions[%u] do not match.",
2751 i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002752 }
2753 }
2754 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002755 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002756 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002757 skip |= LogError(
2758 command_buffer, "VUID-VkImageCopy-layerCount-00138",
2759 "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[%u] do not match", i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002760 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002761 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002762
Dave Houltonc991cc92018-03-06 11:08:51 -07002763 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002764 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002765 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002766 }
2767
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002768 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002769 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2770 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002771 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002772 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002773 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002774 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002775
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002776 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002777 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002778 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002779 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002780 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002781 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002782 }
2783
2784 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002785 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002786 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002787 ss << "vkCmdCopyImage(): pRegion[" << i
2788 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002789 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002790 }
2791
Dave Houltonfc1a4052017-04-27 14:32:45 -06002792 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002793 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2794 if (slice_override) src_copy_extent.depth = depth_slices;
2795 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002796 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002797 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002798 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2799 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2800 "width [%1d].",
2801 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002802 }
2803
2804 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002805 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002806 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2807 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2808 "height [%1d].",
2809 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002810 }
2811 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002812 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002813 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2814 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2815 "depth [%1d].",
2816 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002817 }
2818
Dave Houltonee281a52017-12-08 13:51:02 -07002819 // Adjust dest extent if necessary
2820 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2821 if (slice_override) dst_copy_extent.depth = depth_slices;
2822
2823 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002824 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002825 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2826 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2827 "width [%1d].",
2828 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002829 }
2830 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002831 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2832 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2833 "height [%1d].",
2834 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002835 }
2836 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002837 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2838 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2839 "depth [%1d].",
2840 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002841 }
2842
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002843 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2844 // must not overlap in memory
2845 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002846 for (uint32_t j = 0; j < regionCount; j++) {
2847 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002848 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002849 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002850 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002851 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002852 }
2853 }
2854 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002855
2856 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2857 if (device_extensions.vk_khr_maintenance1) {
2858 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2859 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2860 (src_copy_extent.depth != 1)) {
2861 skip |= LogError(
2862 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2863 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2864 src_copy_extent.depth);
2865 }
2866 } else {
2867 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2868 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2869 (src_copy_extent.depth != 1)) {
2870 skip |= LogError(
2871 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2872 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2873 src_copy_extent.depth);
2874 }
2875 }
2876
2877 // Check if 2D with 3D and depth not equal to 2D layerCount
2878 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2879 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2880 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2881 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2882 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2883 "srcSubresource.layerCount (%u)",
2884 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2885 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2886 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2887 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2888 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2889 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2890 "dstSubresource.layerCount (%u)",
2891 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2892 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002893
2894 // Check for multi-plane format compatiblity
2895 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
2896 size_t src_format_size = 0;
2897 size_t dst_format_size = 0;
2898 if (FormatIsMultiplane(src_format)) {
2899 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
2900 src_format_size = FormatElementSize(planeFormat);
2901 } else {
2902 src_format_size = FormatElementSize(src_format);
2903 }
2904 if (FormatIsMultiplane(dst_format)) {
2905 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
2906 dst_format_size = FormatElementSize(planeFormat);
2907 } else {
2908 dst_format_size = FormatElementSize(dst_format);
2909 }
2910 // If size is still zero, then format is invalid and will be caught in another VU
2911 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
2912 skip |=
2913 LogError(command_buffer, "VUID-vkCmdCopyImage-None-01549",
2914 "vkCmdCopyImage(): pRegions[%u] called with non-compatible image formats. "
2915 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
2916 i, string_VkFormat(src_format), string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(),
2917 string_VkFormat(dst_format), string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
2918 }
2919 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002920 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002921
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002922 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
2923 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
2924 // because because both texels are 4 bytes in size.
2925 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
2926 const char *compatible_vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2927 : "VUID-vkCmdCopyImage-srcImage-00135";
2928 // Depth/stencil formats must match exactly.
2929 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2930 if (src_format != dst_format) {
2931 skip |= LogError(command_buffer, compatible_vuid,
2932 "vkCmdCopyImage(): Depth/stencil formats must match exactly for src (%s) and dst (%s).",
2933 string_VkFormat(src_format), string_VkFormat(dst_format));
2934 }
2935 } else {
2936 if (!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) {
2937 skip |= LogError(command_buffer, compatible_vuid,
2938 "vkCmdCopyImage(): Unmatched image format sizes. "
2939 "The src format %s has size of %zu and dst format %s has size of %zu.",
2940 string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
2941 FormatElementSize(dst_format));
2942 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002943 }
2944 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002945
Dave Houlton33c22b72017-02-28 13:16:02 -07002946 // Source and dest image sample counts must match
2947 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2948 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002949 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002950 }
2951
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002952 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2953 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002954 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002955 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2956 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2957 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2958 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
sfricke-samsung022fa252020-07-24 03:26:16 -07002959 skip |= ValidateProtectedImage(cb_node, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-commandBuffer-01825");
2960 skip |= ValidateProtectedImage(cb_node, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-commandBuffer-01826");
2961 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-commandBuffer-01827");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02002962
2963 // Validation for VK_EXT_fragment_density_map
2964 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2965 skip |= LogError(
2966 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2967 "vkCmdCopyImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2968 }
2969 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2970 skip |= LogError(
2971 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2972 "vkCmdCopyImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2973 }
2974
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002975 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002976 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002977 "VUID-vkCmdCopyImage-srcImage-01995");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002978 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002979 "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002980 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002981 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002982 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002983 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2984 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002985 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002986 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2987 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2988 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2989 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2990 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2991 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002992 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002993 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002994 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2995 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002996 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002997 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2998 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002999 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
3000 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003001 }
3002
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003003 return skip;
3004}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003005
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003006void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3007 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3008 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003009 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3010 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003011 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003012 auto src_image_state = GetImageState(srcImage);
3013 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003014
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003015 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003016 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003017 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3018 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003019 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003020}
3021
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003022// Returns true if sub_rect is entirely contained within rect
3023static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3024 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
3025 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
3026 return false;
3027 return true;
3028}
3029
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003030bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003031 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
3032 const VkRect2D &render_area, uint32_t rect_count,
3033 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003034 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003035 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3036 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06003037 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07003038 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003039
3040 for (uint32_t j = 0; j < rect_count; j++) {
3041 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003042 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3043 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3044 "the current render pass instance.",
3045 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003046 }
3047
3048 if (image_view_state) {
3049 // The layers specified by a given element of pRects must be contained within every attachment that
3050 // pAttachments refers to
3051 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3052 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3053 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003054 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3055 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3056 "of pAttachment[%d].",
3057 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003058 }
3059 }
3060 }
3061 return skip;
3062}
3063
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003064bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3065 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003066 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003067 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003068 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003069 if (!cb_node) return skip;
3070
3071 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3072 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3073 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003074 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003075
3076 // Validate that attachment is in reference list of active subpass
3077 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003078 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003079 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003080 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003081 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003082 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003083
John Zulauf3a548ef2019-02-01 16:14:07 -07003084 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3085 auto clear_desc = &pAttachments[attachment_index];
3086 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003087
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003088 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003089 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003090 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003091 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003092 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003093 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3094 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3095 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3096 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003097 skip |= LogError(
3098 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3099 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3100 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3101 attachment_index, clear_desc->colorAttachment,
3102 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3103 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003104
John Zulauff2582972019-02-09 14:53:30 -07003105 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3106 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003107 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003108 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3109 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3110 " subpass %u. colorAttachmentCount=%u",
3111 attachment_index, clear_desc->colorAttachment,
3112 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3113 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003114 }
John Zulauff2582972019-02-09 14:53:30 -07003115 fb_attachment = color_attachment;
3116
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003117 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3118 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3119 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003120 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003121 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003122 }
3123 } else { // Must be depth and/or stencil
3124 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
3125 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003126 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003127 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003128 }
3129 if (!subpass_desc->pDepthStencilAttachment ||
3130 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003131 skip |= LogPerformanceWarning(
3132 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003133 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003134 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003135 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003136 }
3137 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003138 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003139 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3140 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003141 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003142
3143 // Once the framebuffer attachment is found, can get the image view state
3144 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3145 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3146 const IMAGE_VIEW_STATE *image_view_state =
3147 GetAttachmentImageViewState(GetCBState(commandBuffer), framebuffer, fb_attachment);
3148 if (image_view_state != nullptr) {
3149 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3150 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3151 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3152 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3153 }
3154 }
John Zulauf441558b2019-08-12 11:47:39 -06003155 }
3156 }
3157 return skip;
3158}
3159
3160void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3161 const VkClearAttachment *pAttachments, uint32_t rectCount,
3162 const VkClearRect *pRects) {
3163 auto *cb_node = GetCBState(commandBuffer);
3164 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3165 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3166 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3167 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3168 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3169 const auto clear_desc = &pAttachments[attachment_index];
3170 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3171 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3172 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3173 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3174 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3175 subpass_desc->pDepthStencilAttachment) {
3176 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3177 }
3178 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003179 if (!clear_rect_copy) {
3180 // We need a copy of the clear rectangles that will persist until the last lambda executes
3181 // but we want to create it as lazily as possible
3182 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003183 }
John Zulauf441558b2019-08-12 11:47:39 -06003184 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3185 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003186 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003187 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003188 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003189 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3190 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003191 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
3192 clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003193 return skip;
3194 };
3195 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003196 }
3197 }
3198 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003199}
3200
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003201bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3202 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003203 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003204 const auto *cb_node = GetCBState(commandBuffer);
3205 const auto *src_image_state = GetImageState(srcImage);
3206 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003207
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003208 bool skip = false;
3209 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003210 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3211 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003212 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003213 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003214 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3215 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003216 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003217 "VUID-vkCmdResolveImage-dstImage-02003");
sfricke-samsung022fa252020-07-24 03:26:16 -07003218 skip |=
3219 ValidateProtectedImage(cb_node, src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-commandBuffer-01837");
3220 skip |=
3221 ValidateProtectedImage(cb_node, dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-commandBuffer-01838");
3222 skip |=
3223 ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-commandBuffer-01839");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003224
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003225 // Validation for VK_EXT_fragment_density_map
3226 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3227 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3228 "vkCmdResolveImage(): srcImage must not have been created with flags containing "
3229 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3230 }
3231 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3232 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3233 "vkCmdResolveImage(): dstImage must not have been created with flags containing "
3234 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3235 }
3236
Cort Stratton7df30962018-05-17 19:45:57 -07003237 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003238 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003239 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003240 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3241 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3242 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003243 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003244 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3245 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003246 // For each region, the number of layers in the image subresource should not be zero
3247 // For each region, src and dest image aspect must be color only
3248 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003249 const VkImageResolve region = pRegions[i];
3250 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3251 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003252 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, "vkCmdResolveImage()", "srcSubresource", i);
3253 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, "vkCmdResolveImage()", "dstSubresource", i);
3254 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003255 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3256 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003257 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003258 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3259 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003260 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003261 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003262 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003263 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003264 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
3265 src_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003266 "VUID-vkCmdResolveImage-srcSubresource-01711");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003267 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
3268 dst_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003269 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003270
3271 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003272 if (src_subresource.layerCount != dst_subresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003273 skip |= LogError(
3274 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003275 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%u] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003276 }
Cort Stratton7df30962018-05-17 19:45:57 -07003277 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003278 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3279 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3280 skip |= LogError(
3281 cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266",
3282 "vkCmdResolveImage(): src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3283 i);
3284 }
3285
3286 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3287 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3288
3289 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
3290 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount) ||
3291 (0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3292 LogObjectList objlist(cb_node->commandBuffer);
3293 objlist.add(src_image_state->image);
3294 objlist.add(dst_image_state->image);
3295 skip |= LogError(objlist, "VUID-VkImageResolve-srcImage-00268",
3296 "vkCmdResolveImage(): pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
3297 "subresources if the src or dst image is 3D.",
3298 i);
3299 }
3300 }
3301
3302 if (VK_IMAGE_TYPE_1D == src_image_type) {
3303 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3304 LogObjectList objlist(cb_node->commandBuffer);
3305 objlist.add(src_image_state->image);
3306 skip |= LogError(objlist, "VUID-VkImageResolve-srcImage-00271",
3307 "vkCmdResolveImage(): srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
3308 "extent.height (%u) is not 1.",
3309 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.y,
3310 pRegions[i].extent.height);
3311 }
3312 }
3313 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3314 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3315 LogObjectList objlist(cb_node->commandBuffer);
3316 objlist.add(src_image_state->image);
3317 skip |= LogError(objlist, "VUID-VkImageResolve-srcImage-00273",
3318 "vkCmdResolveImage(): srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
3319 "extent.depth (%u) is not 1.",
3320 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.z,
3321 pRegions[i].extent.depth);
3322 }
3323 }
3324
3325 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3326 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3327 LogObjectList objlist(cb_node->commandBuffer);
3328 objlist.add(dst_image_state->image);
3329 skip |= LogError(objlist, "VUID-VkImageResolve-dstImage-00276",
3330 "vkCmdResolveImage(): dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
3331 "extent.height (%u) is not 1.",
3332 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.y,
3333 pRegions[i].extent.height);
3334 }
3335 }
3336 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3337 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3338 LogObjectList objlist(cb_node->commandBuffer);
3339 objlist.add(dst_image_state->image);
3340 skip |= LogError(objlist, "VUID-VkImageResolve-dstImage-00278",
3341 "vkCmdResolveImage(): dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
3342 "extent.depth (%u) is not 1.",
3343 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.z,
3344 pRegions[i].extent.depth);
3345 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003346 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003347
3348 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3349 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3350 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3351 // developer
3352 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3353 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
3354 if ((extent_check & x_bit) != 0) {
3355 LogObjectList objlist(cb_node->commandBuffer);
3356 objlist.add(src_image_state->image);
3357 skip |= LogError(objlist, "VUID-VkImageResolve-srcOffset-00269",
3358 "vkCmdResolveImage(): srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
3359 "exceeds subResource width [%u].",
3360 report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
3361 region.extent.width, subresource_extent.width);
3362 }
3363
3364 if ((extent_check & y_bit) != 0) {
3365 LogObjectList objlist(cb_node->commandBuffer);
3366 objlist.add(src_image_state->image);
3367 skip |= LogError(objlist, "VUID-VkImageResolve-srcOffset-00270",
3368 "vkCmdResolveImage(): srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
3369 "exceeds subResource height [%u].",
3370 report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
3371 region.extent.height, subresource_extent.height);
3372 }
3373
3374 if ((extent_check & z_bit) != 0) {
3375 LogObjectList objlist(cb_node->commandBuffer);
3376 objlist.add(src_image_state->image);
3377 skip |= LogError(objlist, "VUID-VkImageResolve-srcOffset-00272",
3378 "vkCmdResolveImage(): srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
3379 "exceeds subResource depth [%u].",
3380 report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
3381 region.extent.depth, subresource_extent.depth);
3382 }
3383 }
3384
3385 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3386 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3387 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3388 // developer
3389 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3390 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
3391 if ((extent_check & x_bit) != 0) {
3392 LogObjectList objlist(cb_node->commandBuffer);
3393 objlist.add(dst_image_state->image);
3394 skip |= LogError(objlist, "VUID-VkImageResolve-dstOffset-00274",
3395 "vkCmdResolveImage(): dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
3396 "exceeds subResource width [%u].",
3397 report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
3398 region.extent.width, subresource_extent.width);
3399 }
3400
3401 if ((extent_check & y_bit) != 0) {
3402 LogObjectList objlist(cb_node->commandBuffer);
3403 objlist.add(dst_image_state->image);
3404 skip |= LogError(objlist, "VUID-VkImageResolve-dstOffset-00275",
3405 "vkCmdResolveImage(): dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
3406 "exceeds subResource height [%u].",
3407 report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
3408 region.extent.height, subresource_extent.height);
3409 }
3410
3411 if ((extent_check & z_bit) != 0) {
3412 LogObjectList objlist(cb_node->commandBuffer);
3413 objlist.add(dst_image_state->image);
3414 skip |= LogError(objlist, "VUID-VkImageResolve-dstOffset-00277",
3415 "vkCmdResolveImage(): dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
3416 "exceeds subResource depth [%u].",
3417 report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
3418 region.extent.depth, subresource_extent.depth);
3419 }
3420 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003421 }
3422
3423 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003424 skip |=
3425 LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-01386",
3426 "vkCmdResolveImage(): srcImage format (%s) and dstImage format (%s) are not the same.",
3427 string_VkFormat(src_image_state->createInfo.format), string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003428 }
3429 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003430 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
3431 "vkCmdResolveImage(): srcImage type (%s) and dstImage type (%s) are not the same.",
3432 string_VkImageType(src_image_state->createInfo.imageType),
3433 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003434 }
3435 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003436 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257",
3437 "vkCmdResolveImage(): srcImage sample count is VK_SAMPLE_COUNT_1_BIT.");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003438 }
3439 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003440 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259",
3441 "vkCmdResolveImage(): dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3442 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003443 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003444 } else {
3445 assert(0);
3446 }
3447 return skip;
3448}
3449
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003450bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3451 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003452 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003453 const auto *cb_node = GetCBState(commandBuffer);
3454 const auto *src_image_state = GetImageState(srcImage);
3455 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003456
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003457 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003458 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003459 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003460 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003461 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003462 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003463 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003464 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003465 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003466 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3467 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003468 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003469 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3470 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003471 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003472 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3473 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003474 skip |=
3475 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003476 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3477 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003478 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003479 "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003480 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003481 "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003482
sfricke-samsung022fa252020-07-24 03:26:16 -07003483 skip |= ValidateProtectedImage(cb_node, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-commandBuffer-01834");
3484 skip |= ValidateProtectedImage(cb_node, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-commandBuffer-01835");
3485 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-commandBuffer-01836");
3486
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003487 // Validation for VK_EXT_fragment_density_map
3488 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3489 skip |= LogError(
3490 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3491 "vkCmdBlitImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3492 }
3493 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3494 skip |= LogError(
3495 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3496 "vkCmdBlitImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3497 }
3498
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003499 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003500
Dave Houlton33c2d252017-06-09 17:08:32 -06003501 VkFormat src_format = src_image_state->createInfo.format;
3502 VkFormat dst_format = dst_image_state->createInfo.format;
3503 VkImageType src_type = src_image_state->createInfo.imageType;
3504 VkImageType dst_type = dst_image_state->createInfo.imageType;
3505
Cort Stratton186b1a22018-05-01 20:18:06 -04003506 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003507 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003508 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003509 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003510 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003511 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003512 }
3513
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003514 if (FormatRequiresYcbcrConversion(src_format)) {
3515 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3516 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3517 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3518 string_VkFormat(src_format));
3519 }
3520
3521 if (FormatRequiresYcbcrConversion(dst_format)) {
3522 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3523 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3524 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3525 string_VkFormat(dst_format));
3526 }
3527
Dave Houlton33c2d252017-06-09 17:08:32 -06003528 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003529 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3530 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003531 }
3532
Dave Houlton33c2d252017-06-09 17:08:32 -06003533 // Validate consistency for unsigned formats
3534 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3535 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003536 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003537 << "the other one must also have unsigned integer format. "
3538 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003539 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003540 }
3541
3542 // Validate consistency for signed formats
3543 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3544 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003545 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003546 << "the other one must also have signed integer format. "
3547 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003548 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003549 }
3550
3551 // Validate filter for Depth/Stencil formats
3552 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3553 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003554 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003555 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003556 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003557 }
3558
3559 // Validate aspect bits and formats for depth/stencil images
3560 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3561 if (src_format != dst_format) {
3562 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003563 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003564 << "stencil, the other one must have exactly the same format. "
3565 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3566 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003567 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003568 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003569 } // Depth or Stencil
3570
3571 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003572 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003573 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003574 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3575 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3576 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003577 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003578 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3579 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003580 for (uint32_t i = 0; i < regionCount; i++) {
3581 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003582 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003583 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003584 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3585 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003586 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003587 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3588 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003589 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3590 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3591 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003592 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003593 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003594 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003595 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003596 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3597 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003598 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003599 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3600 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003601 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003602 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3603 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003604 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003605 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003606 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003607 }
Dave Houlton48989f32017-05-26 15:01:46 -06003608 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3609 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003610 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003611 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003612 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003613 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003614
3615 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003616 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003617 skip |= LogError(
3618 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003619 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003620 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003621
Dave Houlton48989f32017-05-26 15:01:46 -06003622 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003623 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3624 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003625 }
Dave Houlton48989f32017-05-26 15:01:46 -06003626
Dave Houlton33c2d252017-06-09 17:08:32 -06003627 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003628 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3629 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3630 "image format %s.",
3631 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003632 }
3633
3634 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003635 skip |= LogError(
3636 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003637 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3638 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003639 }
3640
Dave Houlton48989f32017-05-26 15:01:46 -06003641 // Validate source image offsets
3642 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003643 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003644 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003645 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003646 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3647 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3648 "of (%1d, %1d). These must be (0, 1).",
3649 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003650 }
3651 }
3652
Dave Houlton33c2d252017-06-09 17:08:32 -06003653 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003654 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003655 skip |=
3656 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3657 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3658 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3659 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003660 }
3661 }
3662
Dave Houlton33c2d252017-06-09 17:08:32 -06003663 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003664 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3665 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003666 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003667 skip |= LogError(
3668 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003669 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3670 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003671 }
3672 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3673 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003674 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003675 skip |= LogError(
3676 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003677 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003678 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003679 }
3680 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3681 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003682 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003683 skip |= LogError(
3684 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003685 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3686 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003687 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003688 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003689 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3690 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003691 }
Dave Houlton48989f32017-05-26 15:01:46 -06003692
3693 // Validate dest image offsets
3694 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003695 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003696 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003697 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003698 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3699 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3700 "(%1d, %1d). These must be (0, 1).",
3701 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003702 }
3703 }
3704
Dave Houlton33c2d252017-06-09 17:08:32 -06003705 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003706 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003707 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3708 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3709 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3710 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003711 }
3712 }
3713
Dave Houlton33c2d252017-06-09 17:08:32 -06003714 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003715 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3716 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003717 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003718 skip |= LogError(
3719 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003720 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3721 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003722 }
3723 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3724 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003725 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003726 skip |= LogError(
3727 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003728 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003729 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003730 }
3731 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3732 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003733 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003734 skip |= LogError(
3735 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003736 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3737 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003738 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003739 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003740 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3741 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003742 }
3743
Dave Houlton33c2d252017-06-09 17:08:32 -06003744 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3745 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3746 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003747 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003748 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3749 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3750 "layerCount other than 1.",
3751 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003752 }
3753 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003754 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003755 } else {
3756 assert(0);
3757 }
3758 return skip;
3759}
3760
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003761void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3762 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3763 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003764 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3765 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003766 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003767 auto src_image_state = GetImageState(srcImage);
3768 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003769
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003770 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003771 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003772 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3773 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003774 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003775}
3776
John Zulauf2076e812020-01-08 14:55:54 -07003777GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3778 assert(map);
3779 // This approach allows for a single hash lookup or/create new
3780 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3781 if (inserted.second) {
3782 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06003783 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07003784 inserted.first->second.reset(layout_map);
3785 return layout_map;
3786 } else {
3787 assert(nullptr != inserted.first->second.get());
3788 return inserted.first->second.get();
3789 }
3790 return nullptr;
3791}
3792
3793const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3794 auto it = map.find(image);
3795 if (it != map.end()) {
3796 return it->second.get();
3797 }
3798 return nullptr;
3799}
3800
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003801// 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 -07003802bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3803 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06003804 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003805 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003806 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003807 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003808 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003809 for (const auto &layout_map_entry : pCB->image_layout_map) {
3810 const auto image = layout_map_entry.first;
3811 const auto *image_state = GetImageState(image);
3812 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003813 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003814 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003815 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003816 if (initial_layout_map.empty()) continue;
3817
3818 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3819 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3820 if (global_map == nullptr) {
3821 global_map = &empty_map;
3822 }
3823
3824 // Note: don't know if it would matter
3825 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3826
3827 auto pos = initial_layout_map.begin();
3828 const auto end = initial_layout_map.end();
3829 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3830 pos->first.begin);
3831 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003832 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003833 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003834 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 -07003835 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003836 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003837 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003838 image_layout = current_layout->pos_B->lower_bound->second;
3839 }
3840 const auto intersected_range = pos->first & current_layout->range;
3841 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3842 // TODO: Set memory invalid which is in mem_tracker currently
3843 } else if (image_layout != initial_layout) {
3844 // Need to look up the inital layout *state* to get a bit more information
3845 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3846 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3847 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3848 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07003849 // We can report all the errors for the intersected range directly
3850 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06003851 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003852 skip |= LogError(
3853 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003854 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003855 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07003856 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003857 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06003858 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003859 }
3860 }
John Zulauf2076e812020-01-08 14:55:54 -07003861 if (pos->first.includes(intersected_range.end)) {
3862 current_layout.seek(intersected_range.end);
3863 } else {
3864 ++pos;
3865 if (pos != end) {
3866 current_layout.seek(pos->first.begin);
3867 }
3868 }
John Zulauff660ad62019-03-23 07:16:05 -06003869 }
3870
locke-lunargf155ccf2020-02-18 11:34:15 -07003871 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003872 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003873 }
John Zulauff660ad62019-03-23 07:16:05 -06003874
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003875 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003876}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003877
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003878void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003879 for (const auto &layout_map_entry : pCB->image_layout_map) {
3880 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003881 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003882 const auto *image_state = GetImageState(image);
3883 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003884 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3885 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003886 }
3887}
3888
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003889// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003890// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3891// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003892bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3893 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003894 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003895 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003896 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3897
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003898 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07003899 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
3900 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003901 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003902 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3903 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3904 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003905 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003906 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003907 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07003908 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3909 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
3910 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003911 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003912 string_VkImageLayout(first_layout));
3913 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3914 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003915 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003916 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003917 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003918 }
3919 }
sfricke-samsung55f01952020-03-24 08:16:41 -07003920
3921 // Same as above for loadOp, but for stencilLoadOp
3922 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3923 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3924 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3925 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
3926 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003927 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003928 string_VkImageLayout(first_layout));
3929 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3930 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
3931 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003932 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003933 string_VkImageLayout(first_layout));
3934 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3935 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3936 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003937 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003938 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003939 }
3940 }
3941
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003942 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003943}
3944
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003945bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3946 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003947 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003948 const char *vuid;
3949 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003950
Jason Ekstranda1906302017-12-03 20:16:32 -08003951 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3952 VkFormat format = pCreateInfo->pAttachments[i].format;
3953 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3954 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3955 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003956 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003957 "%s: Render pass pAttachment[%u] has loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003958 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3959 "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 -07003960 "render pass.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003961 function_name, i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003962 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003963 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003964 skip |=
3965 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3966 "%s: Render pass pAttachment[%u] has stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3967 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3968 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3969 "render pass.",
3970 function_name, i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003971 }
3972 }
3973 }
3974
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003975 // Track when we're observing the first use of an attachment
3976 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3977 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003978 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003979
3980 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3981 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3982 auto attach_index = subpass.pInputAttachments[j].attachment;
3983 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003984 switch (subpass.pInputAttachments[j].layout) {
3985 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3986 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3987 // These are ideal.
3988 break;
3989
3990 case VK_IMAGE_LAYOUT_GENERAL:
3991 // May not be optimal. TODO: reconsider this warning based on other constraints.
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003992 skip |= LogPerformanceWarning(
3993 device, kVUID_Core_DrawState_InvalidImageLayout,
3994 "%s: Layout for input attachment reference %u in subpass %u is GENERAL but should be READ_ONLY_OPTIMAL.",
3995 function_name, j, i);
Cort Stratton7547f772017-05-04 15:18:52 -07003996 break;
3997
Tobias Hectorbbb12282018-10-22 15:17:59 +01003998 case VK_IMAGE_LAYOUT_UNDEFINED:
3999 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004000 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004001 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004002 "%s: Layout for input attachment reference %u in subpass %u is %s but must be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004003 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004004 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004005 break;
4006
Piers Daniell9af77cd2019-10-16 13:54:12 -06004007 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4008 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4009 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4010 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004011 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004012 skip |= LogError(
4013 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004014 "%s: Layout for input attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004015 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4016 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004017 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004018 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004019 skip |= LogError(
4020 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004021 "%s: Layout for input attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004022 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4023 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004024 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004025 } else if ((subpass.pInputAttachments[j].aspectMask &
4026 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4027 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4028 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4029 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4030 const auto *attachment_reference_stencil_layout =
4031 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
4032 if (attachment_reference_stencil_layout) {
4033 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4034 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4035 attachment_reference_stencil_layout->stencilLayout ==
4036 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4037 attachment_reference_stencil_layout->stencilLayout ==
4038 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4039 attachment_reference_stencil_layout->stencilLayout ==
4040 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4041 attachment_reference_stencil_layout->stencilLayout ==
4042 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4043 attachment_reference_stencil_layout->stencilLayout ==
4044 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4045 attachment_reference_stencil_layout->stencilLayout ==
4046 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4047 attachment_reference_stencil_layout->stencilLayout ==
4048 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4049 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004050 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004051 "%s: In the attachment reference %u in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004052 "VkAttachmentReferenceStencilLayoutKHR"
4053 "the stencilLayout member but must not be "
4054 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4055 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4056 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4057 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4058 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4059 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4060 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4061 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4062 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004063 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004064 }
4065 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004066 skip |= LogError(
4067 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004068 "%s: When the layout for input attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004069 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4070 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4071 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004072 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004073 }
4074 }
4075 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4076 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4077 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004078 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03315",
4079 "%s: When the aspectMask for input attachment reference %u in subpass %u is "
4080 "VK_IMAGE_ASPECT_DEPTH_BIT "
4081 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4082 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4083 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004084 }
4085 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4086 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4087 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004088 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004089 "%s: When the aspectMask for input attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004090 "VK_IMAGE_ASPECT_STENCIL_BIT "
4091 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4092 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004093 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004094 }
4095 }
4096 break;
4097
Graeme Leese668a9862018-10-08 10:40:02 +01004098 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4099 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004100 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01004101 break;
4102 } else {
4103 // Intentionally fall through to generic error message
4104 }
4105 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004106
Cort Stratton7547f772017-05-04 15:18:52 -07004107 default:
4108 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004109 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004110 "%s: Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
4111 function_name, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07004112 }
4113
Cort Stratton7547f772017-05-04 15:18:52 -07004114 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004115 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
4116 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07004117
4118 bool used_as_depth =
4119 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
4120 bool used_as_color = false;
4121 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
4122 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
4123 }
4124 if (!used_as_depth && !used_as_color &&
4125 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08004126 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004127 skip |= LogError(device, vuid,
4128 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
Mark Lobodzinski6ff146b2020-05-22 14:37:05 -06004129 function_name, attach_index, i);
Cort Stratton7547f772017-05-04 15:18:52 -07004130 }
4131 }
4132 attach_first_use[attach_index] = false;
4133 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01004134
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004135 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
4136 auto attach_index = subpass.pColorAttachments[j].attachment;
4137 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
4138
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004139 // TODO: Need a way to validate shared presentable images here, currently just allowing
4140 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
4141 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004142 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004143 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06004144 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06004145 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
4146 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004147 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004148
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004149 case VK_IMAGE_LAYOUT_GENERAL:
4150 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004151 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004152 "%s: Layout for color attachment reference %u in subpass %u is GENERAL but "
4153 "should be COLOR_ATTACHMENT_OPTIMAL.",
4154 function_name, j, i);
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004155 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004156
Tobias Hectorbbb12282018-10-22 15:17:59 +01004157 case VK_IMAGE_LAYOUT_UNDEFINED:
4158 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004159 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004160 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004161 "%s: Layout for color attachment reference %u in subpass %u is %s but should be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004162 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004163 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004164 break;
4165
Piers Daniell9af77cd2019-10-16 13:54:12 -06004166 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4167 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4168 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4169 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004170 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004171 skip |= LogError(
4172 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004173 "%s: Layout for color attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004174 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4175 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004176 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004177 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004178 skip |= LogError(
4179 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004180 "%s: Layout for color attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004181 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4182 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004183 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004184 } else if ((subpass.pColorAttachments[j].aspectMask &
4185 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4186 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4187 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4188 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4189 const auto *attachment_reference_stencil_layout =
4190 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
4191 if (attachment_reference_stencil_layout) {
4192 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4193 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4194 attachment_reference_stencil_layout->stencilLayout ==
4195 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4196 attachment_reference_stencil_layout->stencilLayout ==
4197 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4198 attachment_reference_stencil_layout->stencilLayout ==
4199 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4200 attachment_reference_stencil_layout->stencilLayout ==
4201 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4202 attachment_reference_stencil_layout->stencilLayout ==
4203 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4204 attachment_reference_stencil_layout->stencilLayout ==
4205 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4206 attachment_reference_stencil_layout->stencilLayout ==
4207 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4208 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004209 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004210 "%s: In the attachment reference %u in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004211 "VkAttachmentReferenceStencilLayoutKHR"
4212 "the stencilLayout member but must not be "
4213 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4214 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4215 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4216 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4217 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4218 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4219 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4220 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4221 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004222 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004223 }
4224 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004225 skip |= LogError(
4226 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004227 "%s: When the layout for color attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004228 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4229 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4230 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004231 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004232 }
4233 }
4234 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4235 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4236 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004237 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03315",
4238 "%s: When the aspectMask for color attachment reference %u in subpass %u is "
4239 "VK_IMAGE_ASPECT_DEPTH_BIT "
4240 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4241 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4242 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004243 }
4244 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4245 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4246 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004247 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004248 "%s: When the aspectMask for color attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004249 "VK_IMAGE_ASPECT_STENCIL_BIT "
4250 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4251 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004252 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004253 }
4254 }
4255 break;
4256
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004257 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004258 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004259 "%s: Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
4260 function_name, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004261 }
4262
John Zulauf4eee2692019-02-09 16:14:25 -07004263 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
4264 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
4265 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08004266 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004267 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004268 "%s: Layout for resolve attachment reference %u in subpass %u is %s but should be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004269 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004270 function_name, j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004271 }
4272
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004273 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004274 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
4275 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004276 }
4277 attach_first_use[attach_index] = false;
4278 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004279
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004280 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
4281 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004282 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
4283 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
4284 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06004285 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06004286
Dave Houltona9df0ce2018-02-07 10:51:23 -07004287 case VK_IMAGE_LAYOUT_GENERAL:
4288 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
4289 // doing a bunch of transitions.
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004290 skip |= LogPerformanceWarning(
4291 device, kVUID_Core_DrawState_InvalidImageLayout,
4292 "%s: GENERAL layout for depth attachment reference in subpass %u may not give optimal performance.",
4293 function_name, i);
Dave Houltona9df0ce2018-02-07 10:51:23 -07004294 break;
4295
Tobias Hectorbbb12282018-10-22 15:17:59 +01004296 case VK_IMAGE_LAYOUT_UNDEFINED:
4297 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004298 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004299 skip |=
4300 LogError(device, vuid,
4301 "%s: Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
4302 "layout or GENERAL.",
4303 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004304 break;
4305
Piers Daniell9af77cd2019-10-16 13:54:12 -06004306 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4307 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4308 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4309 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004310 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004311 skip |= LogError(
4312 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004313 "%s: Layout for depth attachment reference in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004314 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4315 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004316 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004317 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004318 skip |= LogError(
4319 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004320 "%s: Layout for depth attachment reference in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004321 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4322 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004323 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004324 } else if ((subpass.pDepthStencilAttachment->aspectMask &
4325 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4326 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4327 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4328 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4329 const auto *attachment_reference_stencil_layout =
4330 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
4331 if (attachment_reference_stencil_layout) {
4332 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4333 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4334 attachment_reference_stencil_layout->stencilLayout ==
4335 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4336 attachment_reference_stencil_layout->stencilLayout ==
4337 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4338 attachment_reference_stencil_layout->stencilLayout ==
4339 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4340 attachment_reference_stencil_layout->stencilLayout ==
4341 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4342 attachment_reference_stencil_layout->stencilLayout ==
4343 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4344 attachment_reference_stencil_layout->stencilLayout ==
4345 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4346 attachment_reference_stencil_layout->stencilLayout ==
4347 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4348 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004349 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004350 "%s: In the attachment reference in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004351 "VkAttachmentReferenceStencilLayoutKHR"
4352 "the stencilLayout member but must not be "
4353 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4354 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4355 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4356 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4357 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4358 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4359 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4360 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4361 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004362 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004363 }
4364 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004365 skip |= LogError(
4366 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004367 "%s: When the layout for depth attachment reference in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004368 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4369 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4370 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004371 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004372 }
4373 }
4374 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4375 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4376 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004377 skip |= LogError(
4378 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004379 "%s: When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004380 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4381 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004382 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004383 }
4384 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4385 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4386 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004387 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004388 "%s: When the aspectMask for depth attachment reference in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004389 "VK_IMAGE_ASPECT_STENCIL_BIT "
4390 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4391 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004392 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004393 }
4394 }
4395 break;
4396
Dave Houltona9df0ce2018-02-07 10:51:23 -07004397 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4398 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004399 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004400 break;
4401 } else {
4402 // Intentionally fall through to generic error message
4403 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004404 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004405
Dave Houltona9df0ce2018-02-07 10:51:23 -07004406 default:
4407 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004408 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004409 "%s: Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004410 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004411 function_name, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004412 }
4413
4414 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4415 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004416 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4417 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004418 }
4419 attach_first_use[attach_index] = false;
4420 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004421 }
4422 return skip;
4423}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004424
Mark Lobodzinski96210742017-02-09 10:33:46 -07004425// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4426// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004427template <typename T1>
4428bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4429 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4430 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004431 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004432 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004433 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004434 if (strict) {
4435 correct_usage = ((actual & desired) == desired);
4436 } else {
4437 correct_usage = ((actual & desired) != 0);
4438 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004439
Mark Lobodzinski96210742017-02-09 10:33:46 -07004440 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004441 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004442 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004443 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
4444 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4445 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004446 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004447 skip = LogError(object, msgCode,
4448 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4449 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004450 }
4451 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004452 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004453}
4454
4455// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4456// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004457bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004458 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004459 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004460 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004461}
4462
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004463bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004464 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004465 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004466 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4467 if ((image_format_features & desired) != desired) {
4468 // Same error, but more details if it was an AHB external format
4469 if (image_state->has_ahb_format == true) {
4470 skip |= LogError(image_state->image, vuid,
4471 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4472 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4473 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004474 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004475 } else {
4476 skip |= LogError(image_state->image, vuid,
4477 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4478 "with tiling %s.",
4479 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4480 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4481 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004482 }
4483 }
4484 return skip;
4485}
4486
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004487bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004488 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004489 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004490 // layerCount must not be zero
4491 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004492 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4493 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004494 }
4495 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4496 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004497 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4498 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004499 }
4500 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4501 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4502 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004503 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4504 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4505 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4506 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004507 }
4508 return skip;
4509}
4510
Mark Lobodzinski96210742017-02-09 10:33:46 -07004511// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4512// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004513bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004514 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004515 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004516 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004517}
4518
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004519bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004520 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004521 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004522
4523 const VkDeviceSize &range = pCreateInfo->range;
4524 if (range != VK_WHOLE_SIZE) {
4525 // Range must be greater than 0
4526 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004527 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004528 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004529 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4530 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004531 }
4532 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004533 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4534 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004535 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004536 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004537 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4538 "(%" PRIu32 ").",
4539 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004540 }
4541 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004542 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004543 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004544 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004545 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4546 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4547 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004548 }
4549 // The sum of range and offset must be less than or equal to the size of buffer
4550 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004551 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004552 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004553 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4554 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4555 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004556 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004557 } else {
4558 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4559
4560 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4561 // VkPhysicalDeviceLimits::maxTexelBufferElements
4562 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4563 device_limits->maxTexelBufferElements) {
4564 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4565 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4566 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4567 "), divided by the element size of the format (%" PRIu32
4568 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4569 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4570 device_limits->maxTexelBufferElements);
4571 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004572 }
4573 return skip;
4574}
4575
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004576bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004577 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004578 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004579 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4580 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004581 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004582 "vkCreateBufferView(): If buffer was created with `usage` containing "
4583 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004584 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004585 }
4586 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4587 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004588 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004589 "vkCreateBufferView(): If buffer was created with `usage` containing "
4590 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004591 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004592 }
4593 return skip;
4594}
4595
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004596bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004597 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004598 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004599
Dave Houltond8ed0212018-05-16 17:18:24 -06004600 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004601
Jeff Bolz87697532019-01-11 22:54:00 -06004602 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4603 if (chained_devaddr_struct) {
4604 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4605 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004606 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4607 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4608 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004609 }
4610 }
4611
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004612 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4613 if (chained_opaqueaddr_struct) {
4614 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4615 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004616 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4617 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4618 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004619 }
4620 }
4621
Shannon McPherson4984e642019-12-05 13:04:34 -07004622 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004623 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4624 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004625 skip |= LogError(
4626 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004627 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4628 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4629 }
4630
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004631 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004632 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4633 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4634 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004635 }
4636
sfricke-samsungedce77a2020-07-03 22:35:13 -07004637 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4638 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4639 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4640 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4641 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4642 }
4643 const VkBufferCreateFlags invalid_flags =
4644 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4645 if ((pCreateInfo->flags & invalid_flags) != 0) {
4646 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4647 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4648 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4649 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4650 }
4651 }
4652
Mark Lobodzinski96210742017-02-09 10:33:46 -07004653 return skip;
4654}
4655
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004656bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004657 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004658 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004659 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004660 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4661 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004662 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004663 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4664 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004665 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004666 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4667 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4668 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004669
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004670 // Buffer view offset must be less than the size of buffer
4671 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004672 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004673 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004674 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4675 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004676 }
4677
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004678 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004679 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4680 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4681 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004682 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4683 : "VUID-VkBufferViewCreateInfo-offset-00926";
4684 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004685 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004686 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4687 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004688 }
4689
4690 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4691 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4692 if ((elementSize % 3) == 0) {
4693 elementSize /= 3;
4694 }
4695 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4696 VkDeviceSize alignmentRequirement =
4697 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4698 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4699 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4700 }
4701 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004702 skip |= LogError(
4703 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004704 "vkCreateBufferView(): If buffer was created with usage containing "
4705 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004706 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4707 ") must be a multiple of the lesser of "
4708 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4709 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4710 "(%" PRId32
4711 ") is VK_TRUE, the size of a texel of the requested format. "
4712 "If the size of a texel is a multiple of three bytes, then the size of a "
4713 "single component of format is used instead",
4714 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4715 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4716 }
4717 }
4718 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4719 VkDeviceSize alignmentRequirement =
4720 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4721 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
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-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004727 "vkCreateBufferView(): If buffer was created with usage containing "
4728 "VK_BUFFER_USAGE_UNIFORM_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::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4732 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
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.uniformTexelBufferOffsetAlignmentBytes,
4738 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4739 }
4740 }
4741 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004742
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004743 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004744
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004745 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004746 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004747 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004748}
4749
Mark Lobodzinski602de982017-02-09 11:01:33 -07004750// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004751bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004752 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004753 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004754 const IMAGE_STATE *image_state = GetImageState(image);
4755 // checks color format and (single-plane or non-disjoint)
4756 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004757 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004758 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004759 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 -07004760 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004761 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 -07004762 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004763 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004764 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004765 skip |= LogError(image, vuid,
4766 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4767 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4768 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004769 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004770 skip |= LogError(image, vuid,
4771 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4772 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4773 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004774 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004775 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004776 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004777 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 -07004778 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004779 skip |=
4780 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 -07004781 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004782 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004783 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004784 skip |=
4785 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 -07004786 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004787 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4788 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004789 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004790 } else if (FormatIsMultiplane(format)) {
4791 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4792 if (3 == FormatPlaneCount(format)) {
4793 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4794 }
4795 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004796 skip |=
4797 LogError(image, vuid,
4798 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4799 "set, where n = [0, 1, 2].",
4800 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004801 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004802 }
4803 return skip;
4804}
4805
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004806bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4807 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004808 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4809 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004810 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004811
4812 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004813 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004814 skip |= LogError(image, errorCodes.base_mip_err,
4815 "%s: %s.baseMipLevel (= %" PRIu32
4816 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4817 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004818 }
Petr Kraus4d718682017-05-18 03:38:41 +02004819
Petr Krausffa94af2017-08-08 21:46:02 +02004820 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4821 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004822 skip |=
4823 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004824 } else {
4825 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004826
Petr Krausffa94af2017-08-08 21:46:02 +02004827 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004828 skip |= LogError(image, errorCodes.mip_count_err,
4829 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4830 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4831 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4832 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004833 }
Petr Kraus4d718682017-05-18 03:38:41 +02004834 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004835 }
Petr Kraus4d718682017-05-18 03:38:41 +02004836
4837 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004838 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004839 skip |= LogError(image, errorCodes.base_layer_err,
4840 "%s: %s.baseArrayLayer (= %" PRIu32
4841 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4842 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004843 }
Petr Kraus4d718682017-05-18 03:38:41 +02004844
Petr Krausffa94af2017-08-08 21:46:02 +02004845 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4846 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004847 skip |=
4848 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004849 } else {
4850 const uint64_t necessary_layer_count =
4851 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004852
Petr Krausffa94af2017-08-08 21:46:02 +02004853 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004854 skip |= LogError(image, errorCodes.layer_count_err,
4855 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4856 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4857 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4858 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004859 }
Petr Kraus4d718682017-05-18 03:38:41 +02004860 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004861 }
Petr Kraus4d718682017-05-18 03:38:41 +02004862
Mark Lobodzinski602de982017-02-09 11:01:33 -07004863 return skip;
4864}
4865
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004866bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004867 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004868 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004869 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4870 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4871 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4872
4873 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4874 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4875
4876 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004877 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4878 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004879 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004880 : "VUID-VkImageViewCreateInfo-image-01482")
4881 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4882 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004883 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004884 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4885 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004886
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004887 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004888 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004889 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004890}
4891
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004892bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004893 const VkImageSubresourceRange &subresourceRange,
4894 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004895 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004896 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4897 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4898 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4899 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004900
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004901 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004902 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004903 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004904}
4905
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004906bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004907 const VkImageSubresourceRange &subresourceRange,
4908 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004909 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004910 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4911 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4912 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4913 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004914
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004915 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004916 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4917 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004918}
4919
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004920bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004921 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004922 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004923 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004924 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4925 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4926 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4927 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004928
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004929 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004930 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004931}
4932
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004933bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4934 const VkImageUsageFlags image_usage) const {
4935 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4936 bool skip = false;
4937
4938 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4939 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4940
4941 if (image_state->has_ahb_format == true) {
4942 // AHB image view and image share same feature sets
4943 tiling_features = image_state->format_features;
4944 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4945 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4946 assert(device_extensions.vk_ext_image_drm_format_modifier);
4947 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4948 nullptr};
4949 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4950
4951 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4952 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4953 nullptr};
4954 format_properties_2.pNext = (void *)&drm_properties_list;
4955 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4956
4957 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4958 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4959 0) {
4960 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4961 }
4962 }
4963 } else {
4964 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4965 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4966 : format_properties.optimalTilingFeatures;
4967 }
4968
4969 if (tiling_features == 0) {
4970 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4971 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4972 "physical device.",
4973 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4974 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4975 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4976 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4977 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4978 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4979 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4980 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4981 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4982 "VK_IMAGE_USAGE_STORAGE_BIT.",
4983 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4984 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4985 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4986 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4987 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4988 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4989 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4990 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4991 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4992 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4993 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4994 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4995 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4996 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4997 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4998 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4999 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
5000 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
5001 }
5002
5003 return skip;
5004}
5005
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005006bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005007 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07005008 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005009 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005010 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07005011 skip |=
5012 ValidateImageUsageFlags(image_state,
5013 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
5014 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
5015 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
5016 false, kVUIDUndefined, "vkCreateImageView()",
5017 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
5018 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005019 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005020 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07005021 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02005022 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005023 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005024 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07005025
5026 VkImageCreateFlags image_flags = image_state->createInfo.flags;
5027 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005028 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005029 VkFormat view_format = pCreateInfo->format;
5030 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06005031 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005032 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07005033
Dave Houltonbd2e2622018-04-10 16:41:14 -06005034 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005035 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06005036 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005037 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05005038 if (!device_extensions.vk_ext_separate_stencil_usage) {
5039 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005040 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
5041 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
5042 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05005043 }
5044 } else {
5045 const auto image_stencil_struct =
5046 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
5047 if (image_stencil_struct == nullptr) {
5048 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005049 skip |= LogError(
5050 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005051 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
5052 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
5053 "any bits that were not set in VkImageCreateInfo::usage used to create image");
5054 }
5055 } else {
5056 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
5057 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
5058 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005059 skip |= LogError(
5060 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005061 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5062 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5063 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
5064 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
5065 }
5066 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
5067 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005068 skip |= LogError(
5069 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05005070 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
5071 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
5072 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
5073 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
5074 }
5075 }
5076 }
5077 }
5078
Dave Houltonbd2e2622018-04-10 16:41:14 -06005079 image_usage = chained_ivuci_struct->usage;
5080 }
5081
Dave Houlton6f5f20a2018-05-04 12:37:44 -06005082 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
5083 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06005084 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01005085 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06005086 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01005087 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06005088 std::stringstream ss;
5089 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01005090 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06005091 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005092 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005093 }
5094 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005095 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06005096 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
5097 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005098 const char *error_vuid;
5099 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5100 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
5101 } else if ((device_extensions.vk_khr_maintenance2) &&
5102 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5103 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
5104 } else if ((!device_extensions.vk_khr_maintenance2) &&
5105 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
5106 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
5107 } else {
5108 // both enabled
5109 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
5110 }
Dave Houltonc7988072018-04-16 11:46:56 -06005111 std::stringstream ss;
5112 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06005113 << " is not in the same format compatibility class as "
5114 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06005115 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
5116 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07005117 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06005118 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06005119 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005120 }
5121 } else {
5122 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07005123 // Unless it is a multi-planar color bit aspect
5124 if ((image_format != view_format) &&
5125 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
5126 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
5127 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07005128 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06005129 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07005130 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07005131 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07005132 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07005133 }
5134 }
5135
5136 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005137 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005138
5139 switch (image_type) {
5140 case VK_IMAGE_TYPE_1D:
5141 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005142 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5143 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5144 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005145 }
5146 break;
5147 case VK_IMAGE_TYPE_2D:
5148 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5149 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5150 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005151 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5152 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5153 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005154 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005155 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5156 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5157 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005158 }
5159 }
5160 break;
5161 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005162 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005163 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5164 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5165 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005166 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005167 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5168 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5169 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005170 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5171 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005172 skip |= LogError(
5173 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5174 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5175 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5176 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5177 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005178 }
5179 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005180 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5181 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5182 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005183 }
5184 }
5185 } else {
5186 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005187 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5188 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5189 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005190 }
5191 }
5192 break;
5193 default:
5194 break;
5195 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005196
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005197 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005198 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005199 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005200 }
5201
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005202 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005203
Jeff Bolz9af91c52018-09-01 21:53:57 -05005204 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5205 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005206 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5207 "vkCreateImageView() If image was created with usage containing "
5208 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
5209 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005210 }
5211 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005212 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5213 "vkCreateImageView() If image was created with usage containing "
5214 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005215 }
5216 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005217
5218 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5219 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5220 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5221 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5222 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5223 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5224 }
5225 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5226 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5227 skip |= LogError(
5228 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5229 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5230 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5231 }
5232 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005233
5234 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5235 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005236 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005237 "vkCreateImageView(): If image was created with usage containing "
5238 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5239 pCreateInfo->subresourceRange.levelCount);
5240 }
5241 }
5242 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5243 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005244 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005245 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5246 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5247 }
5248 } else {
5249 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5250 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5251 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005252 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005253 "vkCreateImageView(): If image was created with usage containing "
5254 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5255 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5256 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5257 }
5258 }
5259 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005260
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005261 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5262 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5263 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5264 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5265 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5266 }
5267 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5268 skip |=
5269 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5270 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5271 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5272 }
5273 }
5274 if (device_extensions.vk_ext_fragment_density_map_2) {
5275 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5276 (pCreateInfo->subresourceRange.layerCount >
5277 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5278 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5279 "vkCreateImageView(): If image was created with flags containing "
5280 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5281 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5282 pCreateInfo->subresourceRange.layerCount,
5283 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5284 }
5285 }
5286
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005287 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
5288 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5289 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5290 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5291 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5292 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5293 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5294 }
5295 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005296 }
5297 return skip;
5298}
5299
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005300bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
5301 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005302 bool skip = false;
5303
5304 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5305 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5306 VkDeviceSize src_min = UINT64_MAX;
5307 VkDeviceSize src_max = 0;
5308 VkDeviceSize dst_min = UINT64_MAX;
5309 VkDeviceSize dst_max = 0;
5310
5311 for (uint32_t i = 0; i < regionCount; i++) {
5312 src_min = std::min(src_min, pRegions[i].srcOffset);
5313 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5314 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5315 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5316
5317 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5318 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005319 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
5320 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
5321 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5322 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005323 }
5324
5325 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5326 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005327 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
5328 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
5329 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5330 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005331 }
5332
5333 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5334 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005335 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
5336 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5337 ") is greater than the source buffer size (%" PRIuLEAST64
5338 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
5339 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005340 }
5341
5342 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5343 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005344 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
5345 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5346 ") is greater than the destination buffer size (%" PRIuLEAST64
5347 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
5348 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005349 }
5350 }
5351
5352 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5353 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5354 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005355 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
5356 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005357 }
5358 }
5359
5360 return skip;
5361}
5362
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005363bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005364 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005365 const auto cb_node = GetCBState(commandBuffer);
5366 const auto src_buffer_state = GetBufferState(srcBuffer);
5367 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005368
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005369 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005370 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5371 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005372 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005373 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005374 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5375 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005376 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005377 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5378 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005379 skip |=
5380 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5381 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005382 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5383 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005384 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
sfricke-samsung022fa252020-07-24 03:26:16 -07005385 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5386 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5387 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005388 return skip;
5389}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005390
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005391bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005392 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005393 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005394 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005395 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005396 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5397 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005398 }
5399 }
5400 return skip;
5401}
5402
Jeff Bolz5c801d12019-10-09 10:38:45 -05005403bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5404 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005405 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005406 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005407
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005408 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005409 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005410 skip |=
5411 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005412 }
5413 return skip;
5414}
5415
Jeff Bolz5c801d12019-10-09 10:38:45 -05005416bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005417 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005418
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005419 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005420 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005421 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005422 }
5423 return skip;
5424}
5425
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005426bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005427 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005428 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005429 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005430 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005431 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005432 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005433 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005434 }
5435 return skip;
5436}
5437
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005438bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005439 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005440 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005441 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005442 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005443 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005444 skip |=
5445 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5446 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005447 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005448 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005449 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5450 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005451 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005452
sfricke-samsung022fa252020-07-24 03:26:16 -07005453 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5454 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5455
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005456 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005457 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5458 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5459 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5460 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005461 }
5462
5463 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005464 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5465 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5466 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5467 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005468 }
5469
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005470 return skip;
5471}
5472
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005473bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
5474 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005475 bool skip = false;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005476 assert(image_state != nullptr);
5477 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005478
5479 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005480 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005481 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5482 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005483 skip |=
5484 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
5485 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5486 "and 1, respectively.",
5487 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005488 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005489 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005490
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005491 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5492 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005493 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
5494 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
5495 "must be 0 and 1, respectively.",
5496 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005497 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005498 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005499
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005500 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5501 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005502 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
5503 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5504 "For 3D images these must be 0 and 1, respectively.",
5505 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005506 }
5507 }
5508
5509 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005510 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005511 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005512
sfricke-samsung125d2b42020-05-28 06:32:43 -07005513 // If not depth/stencil and not multi-plane
5514 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5515 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
5516 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-bufferOffset-01558"
5517 : "VUID-VkBufferImageCopy-bufferOffset-00193";
5518 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005519 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5520 " must be a multiple of this format's texel size (%" PRIu32 ").",
5521 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005522 }
5523
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005524 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5525 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005526 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005527 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
5528 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5529 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005530 }
5531
5532 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5533 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005534 skip |= LogError(
5535 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005536 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5537 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005538 }
5539
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005540 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005541 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005542 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005543 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 -06005544 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5545 static_cast<int32_t>(adjusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005546 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
5547 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5548 "zero or <= image subresource width (%d).",
5549 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005550 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005551 }
5552
5553 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005554 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 -06005555 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5556 static_cast<int32_t>(adjusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005557 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
5558 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5559 "zero or <= image subresource height (%d).",
5560 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005561 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005562 }
5563
5564 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005565 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 -06005566 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5567 static_cast<int32_t>(adjusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005568 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
5569 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5570 "zero or <= image subresource depth (%d).",
5571 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005572 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005573 }
5574
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005575 // subresource aspectMask must have exactly 1 bit set
5576 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005577 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005578 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005579 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005580 "%s(): aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005581 }
5582
5583 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005584 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005585 skip |= LogError(
5586 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005587 "%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 -07005588 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005589 }
5590
5591 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005592 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5593 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005594
5595 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005596 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005597 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5598 ? "VUID-VkBufferImageCopy-None-01735"
5599 : "VUID-VkBufferImageCopy-bufferRowLength-00203";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005600 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005601 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005602 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5603 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005604 }
5605
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005606 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005607 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005608 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5609 ? "VUID-VkBufferImageCopy-None-01736"
5610 : "VUID-VkBufferImageCopy-bufferImageHeight-00204";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005611 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005612 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005613 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5614 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005615 }
5616
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005617 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005618 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5619 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5620 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005621 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01737"
5622 : "VUID-VkBufferImageCopy-imageOffset-00205";
5623 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005624 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5625 "width & height (%d, %d)..",
5626 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5627 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005628 }
5629
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005630 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005631 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005632 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005633 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5634 ? "VUID-VkBufferImageCopy-None-01738"
5635 : "VUID-VkBufferImageCopy-bufferOffset-00206";
5636 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005637 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5638 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5639 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005640 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005641
5642 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005643 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005644 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005645 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005646 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01739"
5647 : "VUID-VkBufferImageCopy-imageExtent-00207";
5648 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005649 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5650 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5651 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5652 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005653 }
5654
5655 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005656 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005657 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005658 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01740"
5659 : "VUID-VkBufferImageCopy-imageExtent-00208";
5660 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005661 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5662 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5663 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5664 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005665 }
5666
5667 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005668 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005669 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005670 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01741"
5671 : "VUID-VkBufferImageCopy-imageExtent-00209";
5672 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005673 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5674 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5675 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5676 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005677 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005678 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005679
5680 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005681 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005682 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005683 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005684 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5685 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5686 "format has three planes.",
5687 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005688 }
5689
5690 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005691 if (0 ==
5692 (region_aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005693 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5694 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5695 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5696 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005697 } else {
5698 // Know aspect mask is valid
5699 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5700 const uint32_t compatible_size = FormatElementSize(compatible_format);
5701 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5702 skip |= LogError(
5703 image_state->image, "VUID-VkBufferImageCopy-bufferOffset-01559",
5704 "%s(): pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
5705 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5706 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5707 string_VkFormat(compatible_format));
5708 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005709 }
5710 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005711 }
5712
5713 return skip;
5714}
5715
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005716bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5717 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005718 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005719 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005720
5721 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005722 VkExtent3D extent = pRegions[i].imageExtent;
5723 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005724
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005725 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5726 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005727 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5728 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5729 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005730 }
5731
5732 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5733
5734 // 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 -06005735 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005736 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005737 if (image_extent.width % block_extent.width) {
5738 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5739 }
5740 if (image_extent.height % block_extent.height) {
5741 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5742 }
5743 if (image_extent.depth % block_extent.depth) {
5744 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5745 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005746 }
5747
Dave Houltonfc1a4052017-04-27 14:32:45 -06005748 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005749 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005750 }
5751 }
5752
5753 return skip;
5754}
5755
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005756bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5757 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005758 bool skip = false;
5759
5760 VkDeviceSize buffer_size = buff_state->createInfo.size;
5761
5762 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005763 VkDeviceSize max_buffer_offset =
5764 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5765 if (buffer_size < max_buffer_offset) {
5766 skip |=
5767 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 -07005768 }
5769 }
5770
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005771 return skip;
5772}
5773
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005774bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005775 VkBuffer dstBuffer, uint32_t regionCount,
5776 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005777 const auto cb_node = GetCBState(commandBuffer);
5778 const auto src_image_state = GetImageState(srcImage);
5779 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005780
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005781 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005782
5783 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005784 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005785
5786 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005787 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005788
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005789 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005790
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005791 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005792 skip |=
5793 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5794 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5795 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005796 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005797 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005798 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005799 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005800 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005801
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005802 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005803 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005804 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5805 skip |=
5806 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005807
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005808 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005809 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005810 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5811 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005812 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005813 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5814 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
sfricke-samsung022fa252020-07-24 03:26:16 -07005815 skip |= ValidateProtectedImage(cb_node, src_image_state, "vkCmdCopyImageToBuffer()",
5816 "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831");
5817 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyImageToBuffer()",
5818 "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832");
5819 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyImageToBuffer()",
5820 "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005821
5822 // Validation for VK_EXT_fragment_density_map
5823 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5824 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyImageToBuffer-srcImage-02544",
5825 "vkCmdCopyBufferToImage(): srcImage must not have been created with flags containing "
5826 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5827 }
5828
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005829 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005830 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005831 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005832 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005833 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005834 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005835 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5836 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5837 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005838 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005839 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005840 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005841 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005842 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5843 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005844 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5845 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5846 skip |=
5847 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5848 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5849 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005850 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5851 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005852 }
5853 return skip;
5854}
5855
John Zulauf1686f232019-07-09 16:27:11 -06005856void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5857 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5858 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5859
5860 auto cb_node = GetCBState(commandBuffer);
5861 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005862 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005863 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005864 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005865 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005866}
5867
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005868bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5869 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005870 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005871 const auto cb_node = GetCBState(commandBuffer);
5872 const auto src_buffer_state = GetBufferState(srcBuffer);
5873 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005874
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005875 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005876
5877 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005878 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005879
5880 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005881 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005882 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005883 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005884 skip |=
5885 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5886 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5887 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005888 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005889 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005890 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005891 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005892 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005893 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005894 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005895 skip |=
5896 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5897 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005898 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005899 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5900 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005901 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005902 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5903 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
sfricke-samsung022fa252020-07-24 03:26:16 -07005904 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBufferToImage()",
5905 "VUID-vkCmdCopyBufferToImage-commandBuffer-01828");
5906 skip |= ValidateProtectedImage(cb_node, dst_image_state, "vkCmdCopyBufferToImage()",
5907 "VUID-vkCmdCopyBufferToImage-commandBuffer-01829");
5908 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdCopyBufferToImage()",
5909 "VUID-vkCmdCopyBufferToImage-commandBuffer-01830");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005910
5911 // Validation for VK_EXT_fragment_density_map
5912 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5913 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyBufferToImage-dstImage-02543",
5914 "vkCmdCopyBufferToImage(): dstImage must not have been created with flags containing "
5915 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5916 }
5917
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005918 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005919 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005920 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005921 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005922 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005923 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005924 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5925 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5926 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005927 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005928 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005929 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005930 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005931 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5932 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005933 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5934 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5935 skip |=
5936 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5937 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5938 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005939 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5940 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005941 }
5942 return skip;
5943}
5944
John Zulauf1686f232019-07-09 16:27:11 -06005945void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5946 VkImageLayout dstImageLayout, uint32_t regionCount,
5947 const VkBufferImageCopy *pRegions) {
5948 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5949
5950 auto cb_node = GetCBState(commandBuffer);
5951 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005952 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005953 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005954 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005955 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005956}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005957
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005958bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005959 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005960 bool skip = false;
5961 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5962
Dave Houlton1d960ff2018-01-19 12:17:05 -07005963 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005964 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5965 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5966 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005967 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5968 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005969 }
5970
John Zulaufa26d3c82019-08-14 16:09:08 -06005971 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005972 if (!image_entry) {
5973 return skip;
5974 }
5975
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005976 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5977 if (device_extensions.vk_ext_image_drm_format_modifier) {
5978 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5979 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005980 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5981 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5982 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005983 }
5984 } else {
5985 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005986 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5987 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005988 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005989 }
5990
Dave Houlton1d960ff2018-01-19 12:17:05 -07005991 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005992 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005993 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5994 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5995 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005996 }
5997
Dave Houlton1d960ff2018-01-19 12:17:05 -07005998 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005999 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006000 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6001 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6002 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006003 }
6004
Dave Houlton1d960ff2018-01-19 12:17:05 -07006005 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006006 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006007 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6008 if (FormatIsMultiplane(img_format)) {
6009 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
6010 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6011 if (FormatPlaneCount(img_format) > 2u) {
6012 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
6013 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6014 }
6015 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006016 skip |= LogError(image, vuid,
6017 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6018 ") must be a single-plane specifier flag.",
6019 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006020 }
6021 } else if (FormatIsColor(img_format)) {
6022 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006023 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6024 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6025 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006026 }
6027 } else if (FormatIsDepthOrStencil(img_format)) {
6028 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6029 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006030 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006031 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6032 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6033 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6034 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006035 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6036 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6037 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006038 }
6039 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006040
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006041 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006042 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006043 }
6044
Mike Weiblen672b58b2017-02-21 14:32:53 -07006045 return skip;
6046}
sfricke-samsung022fa252020-07-24 03:26:16 -07006047
6048// Validates the image is allowed to be protected
6049bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
6050 const char *vuid) const {
6051 bool skip = false;
6052 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6053 LogObjectList objlist(cb_state->commandBuffer);
6054 objlist.add(image_state->image);
6055 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while image %s is a protected image", cmd_name,
6056 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6057 report_data->FormatHandle(image_state->image).c_str());
6058 }
6059 return skip;
6060}
6061
6062// Validates the image is allowed to be unprotected
6063bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
6064 const char *vuid) const {
6065 bool skip = false;
6066 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6067 LogObjectList objlist(cb_state->commandBuffer);
6068 objlist.add(image_state->image);
6069 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while image %s is an unprotected image", cmd_name,
6070 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6071 report_data->FormatHandle(image_state->image).c_str());
6072 }
6073 return skip;
6074}
6075
6076// Validates the buffer is allowed to be protected
6077bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
6078 const char *vuid) const {
6079 bool skip = false;
6080 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6081 LogObjectList objlist(cb_state->commandBuffer);
6082 objlist.add(buffer_state->buffer);
6083 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while buffer %s is a protected buffer", cmd_name,
6084 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6085 report_data->FormatHandle(buffer_state->buffer).c_str());
6086 }
6087 return skip;
6088}
6089
6090// Validates the buffer is allowed to be unprotected
6091bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
6092 const char *vuid) const {
6093 bool skip = false;
6094 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6095 LogObjectList objlist(cb_state->commandBuffer);
6096 objlist.add(buffer_state->buffer);
6097 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while buffer %s is an unprotected buffer", cmd_name,
6098 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6099 report_data->FormatHandle(buffer_state->buffer).c_str());
6100 }
6101 return skip;
6102}