blob: 89f03141dacb9aa97fdd10ec2885ce36a2942c9a [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 NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
53 const VkImageSubresourceRange &range);
54static VkImageSubresourceRange MakeImageFullRange(const VkImageCreateInfo &create_info) {
55 const auto format = create_info.format;
56 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
57 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
58 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
59 } else {
60 init_range.aspectMask =
61 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
62 }
63 return NormalizeSubresourceRange(create_info, init_range);
64}
65
John Zulauff660ad62019-03-23 07:16:05 -060066IMAGE_STATE::IMAGE_STATE(VkImage img, const VkImageCreateInfo *pCreateInfo)
67 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -070068 safe_create_info(pCreateInfo),
69 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -060070 valid(false),
71 acquired(false),
72 shared_presentable(false),
73 layout_locked(false),
74 get_sparse_reqs_called(false),
75 sparse_metadata_required(false),
76 sparse_metadata_bound(false),
Spencer Fricke224c9852020-04-06 07:47:29 -070077 external_ahb(false),
John Zulauff660ad62019-03-23 07:16:05 -060078 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -070079 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -060080 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -070081 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -060082 create_from_swapchain(VK_NULL_HANDLE),
83 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -060084 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -070085 range_encoder(full_range),
unknown08c57af2019-06-21 16:33:35 -060086 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060087 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
88 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
89 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
90 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
91 }
92 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
93 }
94
95 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
96 sparse = true;
97 }
Locked8af3732019-05-10 09:47:56 -060098
sfricke-samsunge2441192019-11-06 14:07:57 -080099 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
100 if (externalMemoryInfo) {
101 external_memory_handle = externalMemoryInfo->handleTypes;
102 }
John Zulauff660ad62019-03-23 07:16:05 -0600103}
104
unknown2c877272019-07-11 12:56:50 -0600105bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
106 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
107 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
108 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
109 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
110 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
111 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
112 return is_equal && IsQueueFamilyIndicesEqual(other_createInfo);
113}
114
Jeff Bolz82f854d2019-09-17 14:56:47 -0500115// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
116bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
117 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
118 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
119 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
120 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
121 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
122 is_compatible = is_compatible && IsQueueFamilyIndicesEqual(other_createInfo) && IsTilingEqual(other_createInfo);
123
124 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
125 createInfo.extent.height <= other_createInfo.extent.height &&
126 createInfo.extent.depth <= other_createInfo.extent.depth &&
127 createInfo.arrayLayers <= other_createInfo.arrayLayers;
128 return is_compatible;
129}
130
unknown2c877272019-07-11 12:56:50 -0600131bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700132 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
133 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
134 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700135 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
136 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600137 IsCreateInfoEqual(other_image_state->createInfo)) {
138 return true;
139 }
unknowne1661522019-07-11 13:04:18 -0600140 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
141 return true;
142 }
unknown2c877272019-07-11 12:56:50 -0600143 return false;
144}
145
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500146IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
147 : image_view(iv),
148 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700149 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
150 range_generator(im->range_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500151 samplerConversion(VK_NULL_HANDLE),
152 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600153 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
154 if (conversionInfo) samplerConversion = conversionInfo->conversion;
155 if (image_state) {
156 // A light normalization of the createInfo range
157 auto &sub_res_range = create_info.subresourceRange;
158 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
159 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
160
161 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700162 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500163 samples = image_state->createInfo.samples;
164 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600165 }
166}
167
Dave Houltond9611312018-11-19 17:03:36 -0700168uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
169 // uint cast applies floor()
170 return 1u + (uint32_t)log2(std::max({height, width, depth}));
171}
172
173uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
174
175uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
176
John Zulaufb58415b2019-12-09 15:02:32 -0700177static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
178 const VkImageSubresourceRange &range) {
John Zulauff660ad62019-03-23 07:16:05 -0600179 VkImageSubresourceRange norm = range;
180 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
181
182 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
183 // <arrayLayers> can potentially alias.
184 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
185 ? image_create_info.extent.depth
186 : image_create_info.arrayLayers;
187 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
188
189 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
190 VkImageAspectFlags &aspect_mask = norm.aspectMask;
191 if (FormatIsMultiplane(image_create_info.format)) {
192 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
193 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
194 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
195 if (FormatPlaneCount(image_create_info.format) > 2) {
196 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
197 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700198 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700199 }
John Zulauff660ad62019-03-23 07:16:05 -0600200 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700201}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700202
John Zulaufb58415b2019-12-09 15:02:32 -0700203VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
204 const VkImageCreateInfo &image_create_info = image_state.createInfo;
205 return NormalizeSubresourceRange(image_create_info, range);
206}
207
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500208bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700209 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700210 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700211
John Zulauf2076e812020-01-08 14:55:54 -0700212 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
213 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700214 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
215 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
216
John Zulauf2076e812020-01-08 14:55:54 -0700217 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
218
219 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
220 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700221 return false;
222 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700223
John Zulauf2076e812020-01-08 14:55:54 -0700224 for (auto entry : *layout_range_map) {
225 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700226 }
227 return true;
228}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700229
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600230// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600231void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600232 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
233 VkImageLayout expected_layout) {
234 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
235 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600236 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600237 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700238 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700239 for (const auto &image : image_state.aliasing_images) {
240 auto alias_state = GetImageState(image);
241 // The map state of the aliases should all be in sync, so no need to check the return value
242 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
243 assert(subresource_map);
244 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
245 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700246}
John Zulauff660ad62019-03-23 07:16:05 -0600247
248// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600249void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500250 if (disabled.image_layout_validation) {
251 return;
252 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500253 IMAGE_STATE *image_state = view_state.image_state.get();
254 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700255 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700256 for (const auto &image : image_state->aliasing_images) {
257 image_state = GetImageState(image);
258 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
259 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
260 }
John Zulauff660ad62019-03-23 07:16:05 -0600261}
262
263// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600264void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600265 const VkImageSubresourceRange &range, VkImageLayout layout) {
266 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
267 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600268 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700269 for (const auto &image : image_state.aliasing_images) {
270 auto alias_state = GetImageState(image);
271 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
272 assert(subresource_map);
273 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
274 }
John Zulauff660ad62019-03-23 07:16:05 -0600275}
276
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600277void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600278 VkImageLayout layout) {
279 const IMAGE_STATE *image_state = GetImageState(image);
280 if (!image_state) return;
281 SetImageInitialLayout(cb_node, *image_state, range, layout);
282};
283
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600284void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600285 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
286 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600287}
Dave Houltonddd65c52018-05-08 14:58:01 -0600288
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600289// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700290void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
291 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500292 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600293
John Zulauff660ad62019-03-23 07:16:05 -0600294 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600295 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
296 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600297 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 -0600298 sub_range.baseArrayLayer = 0;
299 sub_range.layerCount = image_state->createInfo.extent.depth;
300 }
301
Piers Daniell4fde9b72019-11-27 16:19:46 -0700302 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
303 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
304 SetImageLayout(cb_node, *image_state, sub_range, layout);
305 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
306 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
307 } else {
308 SetImageLayout(cb_node, *image_state, sub_range, layout);
309 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600310}
311
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700312bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
313 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700314 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600315 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100316 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700317 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100318 const char *vuid;
319 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
320
321 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600322 LogObjectList objlist(image);
323 objlist.add(renderpass);
324 objlist.add(framebuffer);
325 objlist.add(image_view);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700326 skip |= LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
327 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
328 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
329 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100330 return skip;
331 }
332
333 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200334 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
335 if (stencil_usage_info) {
336 image_usage |= stencil_usage_info->stencilUsage;
337 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100338
339 // Check for layouts that mismatch image usages in the framebuffer
340 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800341 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600342 LogObjectList objlist(image);
343 objlist.add(renderpass);
344 objlist.add(framebuffer);
345 objlist.add(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100346 skip |=
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600347 LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700348 "Layout/usage mismatch for attachment %u in %s"
349 " - the %s is %s but the image attached to %s via %s"
350 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
351 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
352 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100353 }
354
355 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
356 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800357 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600358 LogObjectList objlist(image);
359 objlist.add(renderpass);
360 objlist.add(framebuffer);
361 objlist.add(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100362 skip |=
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600363 LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700364 "Layout/usage mismatch for attachment %u in %s"
365 " - the %s is %s but the image attached to %s via %s"
366 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
367 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
368 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100369 }
370
371 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800372 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600373 LogObjectList objlist(image);
374 objlist.add(renderpass);
375 objlist.add(framebuffer);
376 objlist.add(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100377 skip |=
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600378 LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700379 "Layout/usage mismatch for attachment %u in %s"
380 " - the %s is %s but the image attached to %s via %s"
381 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
382 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
383 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100384 }
385
386 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800387 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600388 LogObjectList objlist(image);
389 objlist.add(renderpass);
390 objlist.add(framebuffer);
391 objlist.add(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100392 skip |=
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600393 LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700394 "Layout/usage mismatch for attachment %u in %s"
395 " - the %s is %s but the image attached to %s via %s"
396 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
397 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
398 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100399 }
400
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600401 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100402 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
403 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
404 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
405 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
406 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800407 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600408 LogObjectList objlist(image);
409 objlist.add(renderpass);
410 objlist.add(framebuffer);
411 objlist.add(image_view);
412 skip |= LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700413 "Layout/usage mismatch for attachment %u in %s"
414 " - the %s is %s but the image attached to %s via %s"
415 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
416 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
417 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
418 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100419 }
420 } else {
421 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
422 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
423 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
424 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600425 LogObjectList objlist(image);
426 objlist.add(renderpass);
427 objlist.add(framebuffer);
428 objlist.add(image_view);
429 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700430 "Layout/usage mismatch for attachment %u in %s"
431 " - the %s is %s but the image attached to %s via %s"
432 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
433 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
434 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
435 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100436 }
437 }
438 return skip;
439}
440
John Zulauf17a01bb2019-08-09 16:41:19 -0600441bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700442 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600443 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600444 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700445 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700446 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100447 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100448
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700449 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100450 auto framebuffer = framebuffer_state->framebuffer;
451
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700452 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700453 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
454 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700455 }
John Zulauf8e308292018-09-21 11:34:37 -0600456
Tobias Hectorc9057422019-07-23 12:15:52 +0100457 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
458 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
459 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100460 }
461
Tobias Hectorc9057422019-07-23 12:15:52 +0100462 if (attachments != nullptr) {
463 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
464 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
465 auto image_view = attachments[i];
466 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100467
Tobias Hectorc9057422019-07-23 12:15:52 +0100468 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600469 LogObjectList objlist(pRenderPassBegin->renderPass);
470 objlist.add(framebuffer_state->framebuffer);
471 objlist.add(image_view);
472 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700473 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
474 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
475 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100476 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100477 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100478
479 const VkImage image = view_state->create_info.image;
480 const IMAGE_STATE *image_state = GetImageState(image);
481
482 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600483 LogObjectList objlist(pRenderPassBegin->renderPass);
484 objlist.add(framebuffer_state->framebuffer);
485 objlist.add(image_view);
486 objlist.add(image);
487 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700488 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
489 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
490 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100491 continue;
492 }
493 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
494 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
495
Piers Daniell7f894f62020-01-09 16:33:48 -0700496 // Default to expecting stencil in the same layout.
497 auto attachment_stencil_initial_layout = attachment_initial_layout;
498
499 // If a separate layout is specified, look for that.
500 const auto *attachment_description_stencil_layout =
501 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
502 if (attachment_description_stencil_layout) {
503 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
504 }
505
Tobias Hectorc9057422019-07-23 12:15:52 +0100506 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
507 // in common with the non-const version.)
508 const ImageSubresourceLayoutMap *subresource_map =
509 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
510
511 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
512 LayoutUseCheckAndMessage layout_check(subresource_map);
513 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700514 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
515 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
516 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700517
John Zulauf5e617452019-11-19 14:44:16 -0700518 // Allow for differing depth and stencil layouts
519 VkImageLayout check_layout = attachment_initial_layout;
520 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
521
522 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700523 subres_skip |= LogError(
524 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700525 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
526 "and the %s layout of the attachment is %s. The layouts must match, or the render "
527 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700528 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100529 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700530 }
John Zulauf5e617452019-11-19 14:44:16 -0700531
Tobias Hectorc9057422019-07-23 12:15:52 +0100532 skip |= subres_skip;
533 }
534
535 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
536 framebuffer, render_pass, i, "initial layout");
537
538 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
539 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100540 }
541
Tobias Hectorc9057422019-07-23 12:15:52 +0100542 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
543 auto &subpass = pRenderPassInfo->pSubpasses[j];
544 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
545 auto &attachment_ref = subpass.pInputAttachments[k];
546 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
547 auto image_view = attachments[attachment_ref.attachment];
548 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100549
Tobias Hectorc9057422019-07-23 12:15:52 +0100550 if (view_state) {
551 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700552 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
553 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100554 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100555 }
556 }
557 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100558
Tobias Hectorc9057422019-07-23 12:15:52 +0100559 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
560 auto &attachment_ref = subpass.pColorAttachments[k];
561 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
562 auto image_view = attachments[attachment_ref.attachment];
563 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100564
Tobias Hectorc9057422019-07-23 12:15:52 +0100565 if (view_state) {
566 auto image = view_state->create_info.image;
567 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
568 framebuffer, render_pass, attachment_ref.attachment,
569 "color attachment layout");
570 if (subpass.pResolveAttachments) {
571 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
572 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
573 attachment_ref.attachment, "resolve attachment layout");
574 }
575 }
576 }
577 }
578
579 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
580 auto &attachment_ref = *subpass.pDepthStencilAttachment;
581 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
582 auto image_view = attachments[attachment_ref.attachment];
583 auto view_state = GetImageViewState(image_view);
584
585 if (view_state) {
586 auto image = view_state->create_info.image;
587 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
588 framebuffer, render_pass, attachment_ref.attachment,
589 "input attachment layout");
590 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100591 }
592 }
593 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700594 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600595 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700596}
597
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600598void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700599 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700600 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700601 IMAGE_VIEW_STATE *image_view = nullptr;
602 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
603 const auto attachment_info =
604 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
605 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
606 } else {
607 image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
608 }
John Zulauf8e308292018-09-21 11:34:37 -0600609 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700610 VkImageLayout stencil_layout = kInvalidLayout;
611 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
612 if (attachment_reference_stencil_layout) {
613 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
614 }
615
616 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600617 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700618 }
619}
620
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600621void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
622 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700623 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700624
625 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700626 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700627 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700628 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700629 }
630 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700631 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700632 }
633 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700634 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700635 }
636 }
637}
638
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700639// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
640// 1. Transition into initialLayout state
641// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600642void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700643 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700644 // First transition into initialLayout
645 auto const rpci = render_pass_state->createInfo.ptr();
646 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700647 IMAGE_VIEW_STATE *view_state = nullptr;
648 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
649 const auto attachment_info =
650 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
651 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
652 } else {
653 view_state = GetAttachmentImageViewState(framebuffer_state, i);
654 }
John Zulauf8e308292018-09-21 11:34:37 -0600655 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700656 VkImageLayout stencil_layout = kInvalidLayout;
657 const auto *attachment_description_stencil_layout =
658 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
659 if (attachment_description_stencil_layout) {
660 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
661 }
662
663 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600664 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700665 }
666 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700667 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700668}
669
Dave Houlton10b39482017-03-16 13:18:15 -0600670bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600671 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600672 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600673 }
674 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600675 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600676 }
677 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600678 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600679 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700680 if (0 !=
681 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
682 if (FormatPlaneCount(format) == 1) return false;
683 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600684 return true;
685}
686
Mike Weiblen62d08a32017-03-07 22:18:27 -0700687// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200688bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
689 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600690 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700691 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200692 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600693 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700694
695 switch (layout) {
696 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
697 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600698 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700699 }
700 break;
701 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
702 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600703 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700704 }
705 break;
706 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
707 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600708 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700709 }
710 break;
711 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
712 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600713 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700714 }
715 break;
716 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
717 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600718 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700719 }
720 break;
721 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
722 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600723 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700724 }
725 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600726 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500727 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
728 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
729 }
730 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700731 default:
732 // Other VkImageLayout values do not have VUs defined in this context.
733 break;
734 }
735
Dave Houlton8e9f6542018-05-18 12:18:22 -0600736 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700737 skip |= LogError(img_barrier.image, msg_code,
738 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
739 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
740 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700741 }
742 return skip;
743}
744
745// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600746bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
747 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700748 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700749
Petr Krausad0096a2019-08-09 18:35:04 +0200750 // Scoreboard for checking for duplicate and inconsistent barriers to images
751 struct ImageBarrierScoreboardEntry {
752 uint32_t index;
753 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
754 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
755 const VkImageMemoryBarrier *barrier;
756 };
757 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
758 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
759
John Zulauf463c51e2018-05-31 13:29:20 -0600760 // Scoreboard for duplicate layout transition barriers within the list
761 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
762 ImageBarrierScoreboardImageMap layout_transitions;
763
Mike Weiblen62d08a32017-03-07 22:18:27 -0700764 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200765 const auto &img_barrier = pImageMemoryBarriers[i];
766 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700767
John Zulauf463c51e2018-05-31 13:29:20 -0600768 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
769 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
770 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200771 if (img_barrier.oldLayout != img_barrier.newLayout) {
772 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
773 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600774 if (image_it != layout_transitions.end()) {
775 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200776 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600777 if (subres_it != subres_map.end()) {
778 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200779 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
780 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
781 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700782 skip = LogError(
783 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200784 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600785 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
786 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200787 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
788 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
789 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600790 }
791 entry = new_entry;
792 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200793 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600794 }
795 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200796 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600797 }
798 }
799
Petr Krausad0096a2019-08-09 18:35:04 +0200800 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600801 if (image_state) {
802 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200803 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
804 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600805
806 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
807 if (image_state->layout_locked) {
808 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700809 skip |= LogError(
810 img_barrier.image, 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600811 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600812 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Petr Krausad0096a2019-08-09 18:35:04 +0200813 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
814 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600815 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600816
John Zulaufa4472282019-08-22 14:44:34 -0600817 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700818 const VkFormat image_format = image_create_info.format;
819 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600820 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700821 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700822 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600823 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
824 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700825 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
826 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
827 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
828 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700829 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600830 }
831 } else {
832 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
833 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700834 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03320",
835 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
836 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
837 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700838 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600839 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700840 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700841 }
John Zulauff660ad62019-03-23 07:16:05 -0600842
Petr Krausad0096a2019-08-09 18:35:04 +0200843 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
844 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600845 // TODO: Set memory invalid which is in mem_tracker currently
846 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
847 // subresource.
848 } else if (subresource_map) {
849 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600850 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200851 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700852 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
853 const auto &value = *pos;
854 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700855 subres_skip = LogError(
856 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
John Zulauf5e617452019-11-19 14:44:16 -0700857 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
858 "%s layout is %s.",
859 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
860 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
861 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600862 }
John Zulauf5e617452019-11-19 14:44:16 -0700863 }
John Zulauff660ad62019-03-23 07:16:05 -0600864 skip |= subres_skip;
865 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700866
867 // checks color format and (single-plane or non-disjoint)
868 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
869 if ((FormatIsColor(image_format) == true) &&
870 ((FormatIsMultiplane(image_format) == false) || ((image_create_info.flags & VK_IMAGE_CREATE_DISJOINT_BIT) == 0))) {
871 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
872 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
873 ? "VUID-VkImageMemoryBarrier-image-01671"
874 : "VUID-VkImageMemoryBarrier-image-02902";
875 skip |= LogError(img_barrier.image, vuid,
876 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
877 "but its aspectMask is 0x%" PRIx32 ".",
878 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
879 string_VkFormat(image_format), aspect_mask);
880 }
881 }
882
883 VkImageAspectFlags valid_disjoint_mask =
884 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
885 if ((FormatIsMultiplane(image_format) == true) && ((image_create_info.flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
886 ((aspect_mask & valid_disjoint_mask) == 0)) {
887 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
888 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
889 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
890 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
891 string_VkFormat(image_format), aspect_mask);
892 }
893
894 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
895 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
896 "%s: Image barrier %s references %s of format %s has only two planes but included "
897 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
898 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
899 string_VkFormat(image_format), aspect_mask);
900 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700901 }
902 }
903 return skip;
904}
905
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600906bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200907 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700908
Jeff Bolz6835fda2019-10-06 00:15:34 -0500909 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200910 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700911}
912
John Zulauf6b4aae82018-05-09 13:03:36 -0600913template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600914bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
915 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600916 using BarrierRecord = QFOTransferBarrier<Barrier>;
917 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500918 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600919 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
920 const char *barrier_name = BarrierRecord::BarrierName();
921 const char *handle_name = BarrierRecord::HandleName();
922 const char *transfer_type = nullptr;
923 for (uint32_t b = 0; b < barrier_count; b++) {
924 if (!IsTransferOp(&barriers[b])) continue;
925 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700926 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600927 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600928 const auto found = barrier_sets.release.find(barriers[b]);
929 if (found != barrier_sets.release.cend()) {
930 barrier_record = &(*found);
931 transfer_type = "releasing";
932 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600933 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600934 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600935 const auto found = barrier_sets.acquire.find(barriers[b]);
936 if (found != barrier_sets.acquire.cend()) {
937 barrier_record = &(*found);
938 transfer_type = "acquiring";
939 }
940 }
941 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700942 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
943 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
944 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
945 func_name, barrier_name, b, transfer_type, handle_name,
946 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
947 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600948 }
949 }
950 return skip;
951}
952
John Zulaufa4472282019-08-22 14:44:34 -0600953VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
954 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
955}
956
957const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
958 return device_state.GetImageState(barrier.image);
959}
960
961VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
962 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
963}
964
965const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
966 return device_state.GetBufferState(barrier.buffer);
967}
968
969VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
970
John Zulauf6b4aae82018-05-09 13:03:36 -0600971template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600972void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
973 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500974 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600975 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
976 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600977 auto &barrier = barriers[b];
978 if (IsTransferOp(&barrier)) {
979 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
980 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
981 barrier_sets.release.emplace(barrier);
982 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
983 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
984 barrier_sets.acquire.emplace(barrier);
985 }
986 }
987
988 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
989 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
990 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
991 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
992 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
993 auto handle_state = BarrierHandleState(*this, barrier);
994 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
995 if (!mode_concurrent) {
996 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -0500997 cb_state->queue_submit_functions.emplace_back(
998 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
999 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1000 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1001 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001002 });
1003 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001004 }
1005 }
1006}
1007
John Zulaufa4472282019-08-22 14:44:34 -06001008bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001009 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001010 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001011 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001012 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001013 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1014 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001015 return skip;
1016}
1017
John Zulaufa4472282019-08-22 14:44:34 -06001018void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1019 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1020 const VkImageMemoryBarrier *pImageMemBarriers) {
1021 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1022 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001023}
1024
1025template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001026bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001027 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001028 // Record to the scoreboard or report that we have a duplication
1029 bool skip = false;
1030 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1031 if (!inserted.second && inserted.first->second != cb_state) {
1032 // 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 -06001033 LogObjectList objlist(cb_state->commandBuffer);
1034 objlist.add(barrier.handle);
1035 objlist.add(inserted.first->second->commandBuffer);
1036 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001037 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1038 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1039 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1040 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1041 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001042 }
1043 return skip;
1044}
1045
1046template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001047bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1048 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001049 using BarrierRecord = QFOTransferBarrier<Barrier>;
1050 using TypeTag = typename BarrierRecord::Tag;
1051 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001052 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001053 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001054 const char *barrier_name = BarrierRecord::BarrierName();
1055 const char *handle_name = BarrierRecord::HandleName();
1056 // No release should have an extant duplicate (WARNING)
1057 for (const auto &release : cb_barriers.release) {
1058 // Check the global pending release barriers
1059 const auto set_it = global_release_barriers.find(release.handle);
1060 if (set_it != global_release_barriers.cend()) {
1061 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1062 const auto found = set_for_handle.find(release);
1063 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001064 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1065 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1066 " to dstQueueFamilyIndex %" PRIu32
1067 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1068 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1069 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001070 }
1071 }
1072 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1073 }
1074 // Each acquire must have a matching release (ERROR)
1075 for (const auto &acquire : cb_barriers.acquire) {
1076 const auto set_it = global_release_barriers.find(acquire.handle);
1077 bool matching_release_found = false;
1078 if (set_it != global_release_barriers.cend()) {
1079 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1080 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1081 }
1082 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001083 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1084 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1085 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1086 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1087 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001088 }
1089 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1090 }
1091 return skip;
1092}
1093
John Zulauf3b04ebd2019-07-18 14:08:11 -06001094bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001095 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001096 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001097 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001098 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1099 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001100 return skip;
1101}
1102
1103template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001104void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001105 using BarrierRecord = QFOTransferBarrier<Barrier>;
1106 using TypeTag = typename BarrierRecord::Tag;
1107 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001108 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001109
1110 // Add release barriers from this submit to the global map
1111 for (const auto &release : cb_barriers.release) {
1112 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1113 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1114 global_release_barriers[release.handle].insert(release);
1115 }
1116
1117 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1118 for (const auto &acquire : cb_barriers.acquire) {
1119 // NOTE: We're not using [] because we don't want to create entries for missing releases
1120 auto set_it = global_release_barriers.find(acquire.handle);
1121 if (set_it != global_release_barriers.end()) {
1122 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1123 set_for_handle.erase(acquire);
1124 if (set_for_handle.size() == 0) { // Clean up empty sets
1125 global_release_barriers.erase(set_it);
1126 }
1127 }
1128 }
1129}
1130
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001131void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001132 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1133 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001134}
1135
John Zulauf6b4aae82018-05-09 13:03:36 -06001136// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001137void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001138
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001139void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001140 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001141 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001142 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001143
Chris Forbes4de4b132017-08-21 11:27:08 -07001144 // For ownership transfers, the barrier is specified twice; as a release
1145 // operation on the yielding queue family, and as an acquire operation
1146 // on the acquiring queue family. This barrier may also include a layout
1147 // transition, which occurs 'between' the two operations. For validation
1148 // purposes it doesn't seem important which side performs the layout
1149 // transition, but it must not be performed twice. We'll arbitrarily
1150 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001151 //
1152 // However, we still need to record initial layout for the "initial layout" validation
1153 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001154
Petr Krausad0096a2019-08-09 18:35:04 +02001155 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001156 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001157 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001158 }
1159}
1160
unknown86bcb3a2019-07-11 13:05:36 -06001161void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001162 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001163 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1164 const auto &image_create_info = image_state->createInfo;
1165
1166 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1167 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1168 // for all (potential) layer sub_resources.
1169 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1170 normalized_isr.baseArrayLayer = 0;
1171 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1172 }
1173
John Zulauf2be3fe02019-12-30 09:48:02 -07001174 if (is_release_op) {
1175 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1176 } else {
1177 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1178 }
unknown86bcb3a2019-07-11 13:05:36 -06001179}
1180
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001181bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1182 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1183 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1184 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001185 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001186 assert(cb_node);
1187 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001188 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001189 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001190
John Zulauff660ad62019-03-23 07:16:05 -06001191 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1192 if (subresource_map) {
1193 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001194 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001195 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1196 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001197 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001198 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1199 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1200 "%s layout %s.",
1201 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1202 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1203 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001204 }
John Zulauf5e617452019-11-19 14:44:16 -07001205 }
John Zulauff660ad62019-03-23 07:16:05 -06001206 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001207 }
John Zulauff660ad62019-03-23 07:16:05 -06001208
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001209 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1210 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1211 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001212 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1213 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001214 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1215 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1216 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001217 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001218 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001219 if (image_state->shared_presentable) {
1220 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001221 skip |= LogError(device, layout_invalid_msg_code,
1222 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1223 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001224 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001225 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001226 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001227 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001228 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1229 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1230 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1231 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001232 }
1233 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001234 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001235}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001236bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001237 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1238 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001239 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001240 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1241 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1242}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001243
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001244void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001245 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001246 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001247 if (!renderPass) return;
1248
Tobias Hectorbbb12282018-10-22 15:17:59 +01001249 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001250 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001251 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001252 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001253 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1254 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1255 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1256 } else {
1257 view_state = GetAttachmentImageViewState(framebuffer_state, i);
1258 }
John Zulauf8e308292018-09-21 11:34:37 -06001259 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001260 VkImageLayout stencil_layout = kInvalidLayout;
1261 const auto *attachment_description_stencil_layout =
1262 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1263 if (attachment_description_stencil_layout) {
1264 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1265 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001266 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001267 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001268 }
1269 }
1270}
Dave Houltone19e20d2018-02-02 16:32:41 -07001271
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001272#ifdef VK_USE_PLATFORM_ANDROID_KHR
1273// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1274// This could also move into a seperate core_validation_android.cpp file... ?
1275
1276//
1277// AHB-specific validation within non-AHB APIs
1278//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001279bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001280 bool skip = false;
1281
1282 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1283 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001284 if (0 != ext_fmt_android->externalFormat) {
1285 if (VK_FORMAT_UNDEFINED != create_info->format) {
1286 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001287 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1288 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1289 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001290 }
1291
1292 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001293 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1294 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1295 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001296 }
1297
1298 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001299 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1300 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001301 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1302 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1303 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001304 }
1305
1306 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001307 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1308 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1309 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001310 }
1311 }
1312
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001313 if ((0 != ext_fmt_android->externalFormat) &&
1314 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001315 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001316 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1317 ") which has "
1318 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1319 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001320 }
1321 }
1322
Dave Houltond9611312018-11-19 17:03:36 -07001323 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001324 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001325 skip |=
1326 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1327 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1328 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001329 }
1330 }
1331
1332 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1333 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1334 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001335 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001336 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1337 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1338 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1339 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001340 }
1341
1342 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001343 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1344 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1345 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1346 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1347 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001348 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001349 }
1350
1351 return skip;
1352}
1353
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001354bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001355 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001356 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001357
1358 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001359 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001360 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1361 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001362 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001363 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001364 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001365
Dave Houltond9611312018-11-19 17:03:36 -07001366 // Chain must include a compatible ycbcr conversion
1367 bool conv_found = false;
1368 uint64_t external_format = 0;
1369 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1370 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001371 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001372 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001373 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001374 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001375 }
Dave Houltond9611312018-11-19 17:03:36 -07001376 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001377 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001378 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001379 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1380 "an externalFormat (%" PRIu64
1381 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1382 "with the same external format.",
1383 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001384 }
1385
1386 // Errors in create_info swizzles
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001387 if (((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1388 (create_info->components.r != VK_COMPONENT_SWIZZLE_R)) ||
1389 ((create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1390 (create_info->components.g != VK_COMPONENT_SWIZZLE_G)) ||
1391 ((create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1392 (create_info->components.b != VK_COMPONENT_SWIZZLE_B)) ||
1393 ((create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1394 (create_info->components.a != VK_COMPONENT_SWIZZLE_A))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001395 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1396 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1397 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001398 }
1399 }
Dave Houltond9611312018-11-19 17:03:36 -07001400
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001401 return skip;
1402}
1403
John Zulaufa26d3c82019-08-14 16:09:08 -06001404bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001405 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001406
John Zulaufa26d3c82019-08-14 16:09:08 -06001407 const IMAGE_STATE *image_state = GetImageState(image);
Spencer Fricke224c9852020-04-06 07:47:29 -07001408 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001409 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1410 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1411 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1412 "bound to memory.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001413 }
1414 return skip;
1415}
1416
1417#else
1418
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001419bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001420 return false;
1421}
1422
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001423bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001424
John Zulaufa26d3c82019-08-14 16:09:08 -06001425bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001426
1427#endif // VK_USE_PLATFORM_ANDROID_KHR
1428
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001429bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1430 bool skip = false;
1431
1432 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1433 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1434 const VkImageTiling image_tiling = pCreateInfo->tiling;
1435 const VkFormat image_format = pCreateInfo->format;
1436
1437 if (image_format == VK_FORMAT_UNDEFINED) {
1438 // VU 01975 states format can't be undefined unless an android externalFormat
1439#ifdef VK_USE_PLATFORM_ANDROID_KHR
1440 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1441 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1442 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1443 if (it != ahb_ext_formats_map.end()) {
1444 tiling_features = it->second;
1445 }
1446 }
1447#endif
1448 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1449 uint64_t drm_format_modifier = 0;
1450 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1451 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1452 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1453 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1454
1455 if (drm_explicit != nullptr) {
1456 drm_format_modifier = drm_explicit->drmFormatModifier;
1457 } else {
1458 // VUID 02261 makes sure its only explict or implict in parameter checking
1459 assert(drm_implicit != nullptr);
1460 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1461 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1462 }
1463 }
1464
1465 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1466 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1467 nullptr};
1468 format_properties_2.pNext = (void *)&drm_properties_list;
1469 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
1470
1471 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1472 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1473 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1474 }
1475 }
1476 } else {
1477 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1478 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1479 : format_properties.optimalTilingFeatures;
1480 }
1481
1482 // TODO add VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260 support here
1483
1484 return skip;
1485}
1486
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001487bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001488 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001489 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001490
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001491 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001492 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001493 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1494 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001495 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1496 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001497 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001498 }
1499
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001500 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1501 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001502 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1503 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1504 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001505 }
1506
1507 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001508 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1509 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1510 "height (%d) and arrayLayers (%d) must be >= 6.",
1511 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001512 }
Dave Houlton130c0212018-01-29 13:39:56 -07001513 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001514
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001515 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001516 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1517 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1518 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001519 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1520 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1521 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001522 }
1523
1524 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001525 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1526 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1527 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001528 }
1529
ByumjinConffx991b6062019-08-14 15:17:53 -07001530 if (device_extensions.vk_ext_fragment_density_map) {
1531 uint32_t ceiling_width =
1532 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1533 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1534 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1535 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001536 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1537 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1538 "ceiling of device "
1539 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1540 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1541 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001542 }
1543
1544 uint32_t ceiling_height =
1545 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1546 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1547 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1548 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001549 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1550 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1551 "ceiling of device "
1552 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1553 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1554 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001555 }
1556 }
1557
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001558 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001559 VkResult result = VK_SUCCESS;
1560 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1561 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1562 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1563 &format_limits);
1564 } else {
1565 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1566 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1567 image_format_info.type = pCreateInfo->imageType;
1568 image_format_info.tiling = pCreateInfo->tiling;
1569 image_format_info.usage = pCreateInfo->usage;
1570 image_format_info.flags = pCreateInfo->flags;
1571 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1572 format_limits = image_format_properties.imageFormatProperties;
1573 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001574
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001575 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001576#ifdef VK_USE_PLATFORM_ANDROID_KHR
1577 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1578#endif // VK_USE_PLATFORM_ANDROID_KHR
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001579 skip |= LogError(device, kVUID_Core_Image_FormatNotSupported,
1580 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
1581 "VkGetPhysicalDeviceImageFormatProperties returned back VK_ERROR_FORMAT_NOT_SUPPORTED.",
1582 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001583 } else {
1584 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1585 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001586 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1587 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1588 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001589 }
Dave Houlton130c0212018-01-29 13:39:56 -07001590
Dave Houltona585d132019-01-18 13:05:42 -07001591 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1592 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1593 (uint64_t)pCreateInfo->samples;
1594 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001595
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001596 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001597 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001598 uint64_t ig_mask = imageGranularity - 1;
1599 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001600
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001601 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001602 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1603 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1604 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1605 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001606 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001607
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001608 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001609 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1610 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1611 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001612 }
1613
1614 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001615 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1616 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1617 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001618 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001619 }
1620
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001621 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001622 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1623 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1624 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1625 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001626 skip |= LogError(device, error_vuid,
1627 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1628 "YCbCr Conversion format, arrayLayers must be 1",
1629 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001630 }
1631
1632 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001633 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1634 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1635 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001636 }
1637
1638 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001639 skip |= LogError(
1640 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001641 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1642 string_VkSampleCountFlagBits(pCreateInfo->samples));
1643 }
1644
1645 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001646 skip |= LogError(
1647 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001648 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1649 string_VkImageType(pCreateInfo->imageType));
1650 }
1651 }
1652
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001653 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001654 skip |=
1655 LogError(device, "VUID-VkImageCreateInfo-flags-01924",
1656 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1657 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001658 }
1659
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001660 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001661 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001662 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1663 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001664 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1665 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1666 "format must be block, ETC or ASTC compressed, but is %s",
1667 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001668 }
1669 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001670 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1671 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1672 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001673 }
1674 }
1675 }
1676
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001677 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001678 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1679 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1680 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001681 }
1682
unknown2c877272019-07-11 12:56:50 -06001683 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1684 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1685 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001686 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1687 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1688 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001689 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001690
1691 skip |= ValidateImageFormatFeatures(pCreateInfo);
1692
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001693 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001694}
1695
John Zulauf7eeb6f72019-06-17 11:56:36 -06001696void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1697 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1698 if (VK_SUCCESS != result) return;
1699
1700 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001701 auto image_state = Get<IMAGE_STATE>(*pImage);
1702 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001703}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001704
Jeff Bolz5c801d12019-10-09 10:38:45 -05001705bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001706 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001707 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001708 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001709 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001710 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001711 }
1712 return skip;
1713}
1714
John Zulauf7eeb6f72019-06-17 11:56:36 -06001715void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1716 // Clean up validation specific data
1717 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001718
locke-lunargcba7d5f2019-12-30 16:59:11 -07001719 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001720
1721 // Clean up generic image state
1722 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001723}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001724
John Zulauf07288512019-07-05 11:09:50 -06001725bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001726 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001727
1728 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1729 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001730 skip |= LogError(image_state->image, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001731 }
1732
Dave Houlton1d2022c2017-03-29 11:43:58 -06001733 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001734 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001735 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001736 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001737 char const str[] = "vkCmdClearColorImage called with compressed image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001738 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001739 }
1740
1741 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1742 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001743 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001744 }
1745 return skip;
1746}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001747
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001748uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1749 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1750 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001751 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001752 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001753 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001754 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001755}
1756
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001757uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1758 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1759 uint32_t array_layer_count = range->layerCount;
1760 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1761 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001762 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001763 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001764}
1765
John Zulauf07288512019-07-05 11:09:50 -06001766bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1767 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1768 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001769 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001770 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1771 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001772 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1773 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1774 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001775 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001776
1777 } else {
1778 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1779 if (!device_extensions.vk_khr_shared_presentable_image) {
1780 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001781 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1782 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1783 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001784 }
1785 } else {
1786 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1787 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001788 skip |= LogError(
1789 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001790 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1791 func_name, string_VkImageLayout(dest_image_layout));
1792 }
1793 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001794 }
1795
John Zulauff660ad62019-03-23 07:16:05 -06001796 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001797 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001798 if (subresource_map) {
1799 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001800 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001801 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001802 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1803 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001804 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1805 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1806 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1807 } else {
1808 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001809 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001810 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1811 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1812 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1813 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001814 }
John Zulauf5e617452019-11-19 14:44:16 -07001815 }
John Zulauff660ad62019-03-23 07:16:05 -06001816 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001817 }
1818
1819 return skip;
1820}
1821
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001822bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1823 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001824 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001825 bool skip = false;
1826 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001827 const auto *cb_node = GetCBState(commandBuffer);
1828 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001829 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001830 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001831 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001832 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001833 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001834 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001835 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1836 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001837 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001838 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001839 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001840 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001841 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001842 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1843 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001844 }
sfricke-samsunge775d492020-02-28 09:02:25 -08001845 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
1846 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
1847 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
1848 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
1849 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
1850 string_VkFormat(image_state->createInfo.format));
1851 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001852 }
1853 return skip;
1854}
1855
John Zulaufeabb4462019-07-05 14:13:03 -06001856void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1857 const VkClearColorValue *pColor, uint32_t rangeCount,
1858 const VkImageSubresourceRange *pRanges) {
1859 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1860
1861 auto cb_node = GetCBState(commandBuffer);
1862 auto image_state = GetImageState(image);
1863 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001864 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001865 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001866 }
1867 }
1868}
1869
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001870bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1871 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001872 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001873 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001874
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001875 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001876 const auto *cb_node = GetCBState(commandBuffer);
1877 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001878 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001879 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001880 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001881 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001882 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001883 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001884 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001885 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001886 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001887 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001888 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001889
1890 bool any_include_aspect_depth_bit = false;
1891 bool any_include_aspect_stencil_bit = false;
1892
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001893 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001894 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001895 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001896 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001897 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001898 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1899 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001900 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001901 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1902 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001903 skip |= LogError(commandBuffer, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001904 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001905 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1906 any_include_aspect_depth_bit = true;
1907 }
1908 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1909 any_include_aspect_stencil_bit = true;
1910 }
1911 }
1912 if (any_include_aspect_stencil_bit) {
1913 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1914 if (image_stencil_struct != nullptr) {
1915 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1916 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001917 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1918 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1919 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1920 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001921 }
1922 } else {
1923 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001924 skip |= LogError(
1925 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05001926 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1927 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1928 "in VkImageCreateInfo::usage used to create image");
1929 }
1930 }
1931 }
1932 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001933 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1934 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1935 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001936 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001937 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001938 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001939 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001940 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001941 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1942 char const str[] =
1943 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1944 "set.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001945 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001946 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001947 }
1948 return skip;
1949}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001950
John Zulaufeabb4462019-07-05 14:13:03 -06001951void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1952 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1953 const VkImageSubresourceRange *pRanges) {
1954 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1955 auto cb_node = GetCBState(commandBuffer);
1956 auto image_state = GetImageState(image);
1957 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001958 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001959 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001960 }
1961 }
1962}
1963
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001964// Returns true if [x, xoffset] and [y, yoffset] overlap
1965static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1966 bool result = false;
1967 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1968 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1969
1970 if (intersection_max > intersection_min) {
1971 result = true;
1972 }
1973 return result;
1974}
1975
Dave Houltonc991cc92018-03-06 11:08:51 -07001976// Returns true if source area of first copy region intersects dest area of second region
1977// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1978static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001979 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001980
Dave Houltonc991cc92018-03-06 11:08:51 -07001981 // Separate planes within a multiplane image cannot intersect
1982 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001983 return result;
1984 }
1985
Dave Houltonc991cc92018-03-06 11:08:51 -07001986 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1987 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1988 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001989 result = true;
1990 switch (type) {
1991 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001992 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001993 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001994 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001995 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001996 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001997 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001998 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001999 break;
2000 default:
2001 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2002 assert(false);
2003 }
2004 }
2005 return result;
2006}
2007
Dave Houltonfc1a4052017-04-27 14:32:45 -06002008// Returns non-zero if offset and extent exceed image extents
2009static const uint32_t x_bit = 1;
2010static const uint32_t y_bit = 2;
2011static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002012static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002013 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002014 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002015 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2016 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002017 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002018 }
2019 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2020 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002021 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002022 }
2023 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2024 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002025 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002026 }
2027 return result;
2028}
2029
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002030// Test if two VkExtent3D structs are equivalent
2031static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2032 bool result = true;
2033 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2034 (extent->depth != other_extent->depth)) {
2035 result = false;
2036 }
2037 return result;
2038}
2039
Dave Houltonee281a52017-12-08 13:51:02 -07002040// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
2041// Destination image texel extents must be adjusted by block size for the dest validation checks
2042VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
2043 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06002044 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2045 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002046 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002047 adjusted_extent.width /= block_size.width;
2048 adjusted_extent.height /= block_size.height;
2049 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06002050 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2051 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002052 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002053 adjusted_extent.width *= block_size.width;
2054 adjusted_extent.height *= block_size.height;
2055 adjusted_extent.depth *= block_size.depth;
2056 }
2057 return adjusted_extent;
2058}
2059
Dave Houlton6f9059e2017-05-02 17:15:13 -06002060// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002061static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2062 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002063
2064 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002065 if (mip >= img->createInfo.mipLevels) {
2066 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002067 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002068
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002069 // Don't allow mip adjustment to create 0 dim, but pass along a 0 if that's what subresource specified
Dave Houltonfc1a4052017-04-27 14:32:45 -06002070 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002071
Dave Houltone48cd112019-01-03 17:01:18 -07002072 // If multi-plane, adjust per-plane extent
2073 if (FormatIsMultiplane(img->createInfo.format)) {
2074 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2075 extent.width /= divisors.width;
2076 extent.height /= divisors.height;
2077 }
2078
Jeff Bolzef40fec2018-09-01 22:04:34 -05002079 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2080 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002081 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002082 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2083 } else {
2084 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2085 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2086 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2087 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002088
Dave Houlton6f9059e2017-05-02 17:15:13 -06002089 // Image arrays have an effective z extent that isn't diminished by mip level
2090 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002091 extent.depth = img->createInfo.arrayLayers;
2092 }
2093
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002094 return extent;
2095}
2096
2097// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002098static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002099 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2100}
2101
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002102// Test if the extent argument has any dimensions set to 0.
2103static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2104 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2105}
2106
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002107// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002108VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002109 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2110 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002111 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002112 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002113 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002114 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002115 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002116 granularity.width *= block_size.width;
2117 granularity.height *= block_size.height;
2118 }
2119 }
2120 return granularity;
2121}
2122
2123// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2124static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2125 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002126 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2127 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002128 valid = false;
2129 }
2130 return valid;
2131}
2132
2133// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002134bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002135 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002136 bool skip = false;
2137 VkExtent3D offset_extent = {};
2138 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2139 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2140 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002141 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002142 // 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 -07002143 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002144 skip |= LogError(cb_node->commandBuffer, vuid,
2145 "%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 "
2146 "image transfer granularity is (w=0, h=0, d=0).",
2147 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002148 }
2149 } else {
2150 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2151 // integer multiples of the image transfer granularity.
2152 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002153 skip |= LogError(cb_node->commandBuffer, vuid,
2154 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2155 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2156 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2157 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002158 }
2159 }
2160 return skip;
2161}
2162
2163// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002164bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002165 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002166 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002167 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002168 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002169 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2170 // subresource extent.
2171 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002172 skip |= LogError(cb_node->commandBuffer, vuid,
2173 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2174 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2175 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2176 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002177 }
2178 } else {
2179 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2180 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2181 // subresource extent dimensions.
2182 VkExtent3D offset_extent_sum = {};
2183 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2184 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2185 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002186 bool x_ok = true;
2187 bool y_ok = true;
2188 bool z_ok = true;
2189 switch (image_type) {
2190 case VK_IMAGE_TYPE_3D:
2191 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2192 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002193 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002194 case VK_IMAGE_TYPE_2D:
2195 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2196 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002197 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002198 case VK_IMAGE_TYPE_1D:
2199 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2200 (subresource_extent->width == offset_extent_sum.width));
2201 break;
2202 default:
2203 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2204 assert(false);
2205 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002206 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002207 skip |=
2208 LogError(cb_node->commandBuffer, vuid,
2209 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2210 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2211 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2212 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2213 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2214 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002215 }
2216 }
2217 return skip;
2218}
2219
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002220bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002221 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002222 bool skip = false;
2223 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002224 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2225 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002226 }
2227 return skip;
2228}
2229
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002230bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002231 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002232 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002233 bool skip = false;
2234 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2235 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002236 skip |= LogError(cb_node->commandBuffer, vuid,
2237 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2238 "%u, but provided %s has %u array layers.",
2239 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2240 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002241 }
2242 return skip;
2243}
2244
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002245// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002246bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002247 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002248 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002249 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002250 VkExtent3D granularity = GetScaledItg(cb_node, img);
2251 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002252 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002253 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002254 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002255 return skip;
2256}
2257
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002258// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002259bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002260 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002261 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002262 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002263 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002264 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2265 skip |=
2266 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002267 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002268 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002269 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2270 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002271
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002272 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002273 granularity = GetScaledItg(cb_node, dst_img);
2274 skip |=
2275 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002276 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002277 const VkExtent3D dest_effective_extent =
2278 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002279 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002280 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002281 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002282 return skip;
2283}
2284
Dave Houlton6f9059e2017-05-02 17:15:13 -06002285// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002286bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002287 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002288 bool skip = false;
2289
2290 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002291 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002292
2293 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002294 const VkExtent3D src_copy_extent = region.extent;
2295 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002296 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2297
Dave Houlton6f9059e2017-05-02 17:15:13 -06002298 bool slice_override = false;
2299 uint32_t depth_slices = 0;
2300
2301 // Special case for copying between a 1D/2D array and a 3D image
2302 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2303 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002304 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002305 slice_override = (depth_slices != 1);
2306 } 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 -07002307 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002308 slice_override = (depth_slices != 1);
2309 }
2310
2311 // Do all checks on source image
2312 //
2313 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002314 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002315 skip |=
2316 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2317 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2318 "be 0 and 1, respectively.",
2319 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002320 }
2321 }
2322
Dave Houlton533be9f2018-03-26 17:08:30 -06002323 // VUID-VkImageCopy-srcImage-01785
2324 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 -07002325 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2326 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2327 "these must be 0 and 1, respectively.",
2328 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002329 }
2330
Dave Houlton533be9f2018-03-26 17:08:30 -06002331 // VUID-VkImageCopy-srcImage-01787
2332 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002333 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2334 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2335 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002336 }
2337
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002338 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002339 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002340 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002341 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002342 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2343 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2344 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2345 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002346 }
2347 }
2348 } else { // Pre maint 1
2349 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002350 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002351 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2352 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2353 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2354 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2355 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002356 }
2357 }
2358 }
2359
Dave Houltonc991cc92018-03-06 11:08:51 -07002360 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002361 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002362 if (FormatIsCompressed(src_state->createInfo.format) ||
2363 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002364 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002365 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002366 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2367 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2368 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002369 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002370 skip |= LogError(src_state->image, vuid,
2371 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2372 "texel width & height (%d, %d).",
2373 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002374 }
2375
Dave Houlton94a00372017-12-14 15:08:47 -07002376 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002377 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2378 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002379 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002380 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002381 LogError(src_state->image, vuid,
2382 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2383 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2384 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002385 }
2386
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002387 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002388 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2389 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002390 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002391 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002392 LogError(src_state->image, vuid,
2393 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2394 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2395 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002396 }
2397
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002398 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002399 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2400 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002401 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002402 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002403 LogError(src_state->image, vuid,
2404 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2405 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2406 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002407 }
2408 } // Compressed
2409
2410 // Do all checks on dest image
2411 //
2412 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002413 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002414 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2415 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2416 "these must be 0 and 1, respectively.",
2417 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002418 }
2419 }
2420
Dave Houlton533be9f2018-03-26 17:08:30 -06002421 // VUID-VkImageCopy-dstImage-01786
2422 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 -07002423 skip |=
2424 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2425 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2426 "and 1, respectively.",
2427 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002428 }
2429
2430 // VUID-VkImageCopy-dstImage-01788
2431 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002432 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2433 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2434 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002435 }
2436
2437 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002438 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002439 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2440 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2441 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2442 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002443 }
2444 }
2445 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002446 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002447 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002448 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002449 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002450 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2451 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2452 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2453 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002454 }
2455 }
2456 } else { // Pre maint 1
2457 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002458 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002459 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2460 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2461 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2462 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2463 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002464 }
2465 }
2466 }
2467
Dave Houltonc991cc92018-03-06 11:08:51 -07002468 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2469 if (FormatIsCompressed(dst_state->createInfo.format) ||
2470 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002471 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002472
2473 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002474 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2475 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2476 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002477 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002478 skip |= LogError(dst_state->image, vuid,
2479 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2480 "texel width & height (%d, %d).",
2481 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002482 }
2483
Dave Houlton94a00372017-12-14 15:08:47 -07002484 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002485 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2486 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002487 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002488 skip |= LogError(
2489 dst_state->image, vuid,
2490 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2491 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2492 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002493 }
2494
Dave Houltonee281a52017-12-08 13:51:02 -07002495 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2496 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2497 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002498 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002499 skip |= LogError(dst_state->image, vuid,
2500 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2501 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2502 "height (%d).",
2503 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002504 }
2505
Dave Houltonee281a52017-12-08 13:51:02 -07002506 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2507 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2508 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002509 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002510 skip |= LogError(
2511 dst_state->image, vuid,
2512 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2513 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2514 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002515 }
2516 } // Compressed
2517 }
2518 return skip;
2519}
2520
Dave Houltonc991cc92018-03-06 11:08:51 -07002521// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002522bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002523 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002524 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002525
2526 // Neither image is multiplane
2527 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2528 // If neither image is multi-plane the aspectMask member of src and dst must match
2529 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2530 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002531 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002532 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002533 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002534 }
2535 } else {
2536 // Source image multiplane checks
2537 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2538 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2539 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2540 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002541 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002542 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002543 }
2544 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2545 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2546 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002547 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002548 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002549 }
2550 // Single-plane to multi-plane
2551 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2552 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2553 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002554 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002555 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002556 }
2557
2558 // Dest image multiplane checks
2559 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2560 aspect = region.dstSubresource.aspectMask;
2561 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2562 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002563 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002564 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002565 }
2566 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2567 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2568 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002569 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002570 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002571 }
2572 // Multi-plane to single-plane
2573 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2574 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2575 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002576 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002577 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002578 }
2579 }
2580
2581 return skip;
2582}
2583
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002584bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2585 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002586 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002587 const auto *cb_node = GetCBState(commandBuffer);
2588 const auto *src_image_state = GetImageState(srcImage);
2589 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002590 const VkFormat src_format = src_image_state->createInfo.format;
2591 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002592 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002593
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002594 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002595
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002596 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2597
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002598 for (uint32_t i = 0; i < regionCount; i++) {
2599 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002600
2601 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2602 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002603 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002604
Dave Houlton6f9059e2017-05-02 17:15:13 -06002605 bool slice_override = false;
2606 uint32_t depth_slices = 0;
2607
2608 // Special case for copying between a 1D/2D array and a 3D image
2609 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2610 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2611 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002612 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002613 slice_override = (depth_slices != 1);
2614 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2615 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002616 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002617 slice_override = (depth_slices != 1);
2618 }
2619
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002620 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2621 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2622 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002623 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002624 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002625 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002626 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002627 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2628 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002629 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002630 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2631 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002632
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002633 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002634 // No chance of mismatch if we're overriding depth slice count
2635 if (!slice_override) {
2636 // The number of depth slices in srcSubresource and dstSubresource must match
2637 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2638 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002639 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2640 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002641 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002642 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2643 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002644 if (src_slices != dst_slices) {
2645 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002646 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002647 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002648 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002649 }
2650 }
2651 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002652 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002653 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002654 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002655 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002656 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002657 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002658 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002659 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002660
Dave Houltonc991cc92018-03-06 11:08:51 -07002661 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002662 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002663 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002664 }
2665
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002666 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002667 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2668 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002669 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002670 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002671 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002672 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002673
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002674 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002675 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002676 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002677 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002678 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002679 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002680 }
2681
2682 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002683 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002684 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002685 ss << "vkCmdCopyImage(): pRegion[" << i
2686 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002687 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002688 }
2689
Dave Houltonfc1a4052017-04-27 14:32:45 -06002690 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002691 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2692 if (slice_override) src_copy_extent.depth = depth_slices;
2693 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002694 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002695 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002696 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2697 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2698 "width [%1d].",
2699 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002700 }
2701
2702 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002703 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002704 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2705 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2706 "height [%1d].",
2707 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002708 }
2709 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002710 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002711 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2712 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2713 "depth [%1d].",
2714 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002715 }
2716
Dave Houltonee281a52017-12-08 13:51:02 -07002717 // Adjust dest extent if necessary
2718 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2719 if (slice_override) dst_copy_extent.depth = depth_slices;
2720
2721 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002722 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002723 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2724 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2725 "width [%1d].",
2726 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002727 }
2728 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002729 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2730 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2731 "height [%1d].",
2732 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002733 }
2734 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002735 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2736 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2737 "depth [%1d].",
2738 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002739 }
2740
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002741 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2742 // must not overlap in memory
2743 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002744 for (uint32_t j = 0; j < regionCount; j++) {
2745 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002746 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002747 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002748 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002749 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002750 }
2751 }
2752 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002753
2754 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2755 if (device_extensions.vk_khr_maintenance1) {
2756 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2757 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2758 (src_copy_extent.depth != 1)) {
2759 skip |= LogError(
2760 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2761 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2762 src_copy_extent.depth);
2763 }
2764 } else {
2765 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2766 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2767 (src_copy_extent.depth != 1)) {
2768 skip |= LogError(
2769 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2770 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2771 src_copy_extent.depth);
2772 }
2773 }
2774
2775 // Check if 2D with 3D and depth not equal to 2D layerCount
2776 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2777 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2778 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2779 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2780 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2781 "srcSubresource.layerCount (%u)",
2782 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2783 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2784 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2785 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2786 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2787 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2788 "dstSubresource.layerCount (%u)",
2789 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2790 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002791 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002792
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002793 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2794 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2795 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
sfricke-samsungdce5f692020-03-07 13:59:31 -08002796 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2797 if (src_format != dst_format) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002798 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002799 skip |= LogError(command_buffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002800 }
2801 } else {
sfricke-samsungdce5f692020-03-07 13:59:31 -08002802 if ((!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) && (!FormatIsMultiplane(src_format)) &&
2803 (!FormatIsMultiplane(dst_format))) {
2804 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2805 : "VUID-vkCmdCopyImage-srcImage-00135";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002806 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
sfricke-samsungdce5f692020-03-07 13:59:31 -08002807 skip |= LogError(command_buffer, vuid, "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002808 }
2809 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002810
Dave Houlton33c22b72017-02-28 13:16:02 -07002811 // Source and dest image sample counts must match
2812 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2813 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002814 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002815 }
2816
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002817 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2818 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002819 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002820 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2821 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2822 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2823 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002824 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002825 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002826 "VUID-vkCmdCopyImage-srcImage-01995");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002827 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002828 "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002829 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002830 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002831 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002832 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2833 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002834 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002835 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2836 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2837 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2838 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2839 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2840 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002841 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002842 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002843 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2844 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002845 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002846 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2847 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002848 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2849 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002850 }
2851
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002852 return skip;
2853}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002854
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002855void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2856 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2857 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002858 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2859 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002860 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002861 auto src_image_state = GetImageState(srcImage);
2862 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002863
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002864 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002865 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002866 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2867 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002868 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002869}
2870
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002871// Returns true if sub_rect is entirely contained within rect
2872static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2873 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2874 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2875 return false;
2876 return true;
2877}
2878
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002879bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002880 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2881 const VkRect2D &render_area, uint32_t rect_count,
2882 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002883 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002884 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2885 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002886 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002887 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002888
2889 for (uint32_t j = 0; j < rect_count; j++) {
2890 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002891 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2892 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2893 "the current render pass instance.",
2894 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002895 }
2896
2897 if (image_view_state) {
2898 // The layers specified by a given element of pRects must be contained within every attachment that
2899 // pAttachments refers to
2900 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2901 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2902 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002903 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2904 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2905 "of pAttachment[%d].",
2906 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002907 }
2908 }
2909 }
2910 return skip;
2911}
2912
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002913bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2914 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002915 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002916 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002917 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002918 if (!cb_node) return skip;
2919
2920 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2921 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2922 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002923 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002924
2925 // Validate that attachment is in reference list of active subpass
2926 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002927 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002928 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002929 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002930 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002931 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002932
John Zulauf3a548ef2019-02-01 16:14:07 -07002933 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2934 auto clear_desc = &pAttachments[attachment_index];
2935 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002936
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002937 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002938 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002939 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002940 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002941 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002942 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2943 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2944 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2945 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002946 skip |= LogError(
2947 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2948 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2949 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2950 attachment_index, clear_desc->colorAttachment,
2951 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2952 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002953
John Zulauff2582972019-02-09 14:53:30 -07002954 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2955 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002956 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002957 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2958 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
2959 " subpass %u. colorAttachmentCount=%u",
2960 attachment_index, clear_desc->colorAttachment,
2961 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2962 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002963 }
John Zulauff2582972019-02-09 14:53:30 -07002964 fb_attachment = color_attachment;
2965
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002966 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2967 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2968 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002969 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002970 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002971 }
2972 } else { // Must be depth and/or stencil
2973 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2974 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002975 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002976 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002977 }
2978 if (!subpass_desc->pDepthStencilAttachment ||
2979 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002980 skip |= LogPerformanceWarning(
2981 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002982 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002983 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002984 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002985 }
2986 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002987 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002988 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2989 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002990 }
2991 }
2992 }
2993 return skip;
2994}
2995
2996void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2997 const VkClearAttachment *pAttachments, uint32_t rectCount,
2998 const VkClearRect *pRects) {
2999 auto *cb_node = GetCBState(commandBuffer);
3000 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3001 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3002 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3003 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3004 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3005 const auto clear_desc = &pAttachments[attachment_index];
3006 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3007 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3008 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3009 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3010 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3011 subpass_desc->pDepthStencilAttachment) {
3012 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3013 }
3014 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003015 if (!clear_rect_copy) {
3016 // We need a copy of the clear rectangles that will persist until the last lambda executes
3017 // but we want to create it as lazily as possible
3018 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003019 }
John Zulauf441558b2019-08-12 11:47:39 -06003020 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3021 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003022 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003023 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003024 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003025 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003026 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3027 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003028 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3029 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003030 return skip;
3031 };
3032 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003033 }
3034 }
3035 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003036}
3037
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003038bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3039 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003040 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003041 const auto *cb_node = GetCBState(commandBuffer);
3042 const auto *src_image_state = GetImageState(srcImage);
3043 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003044
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003045 bool skip = false;
3046 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003047 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3048 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003049 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003050 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003051 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3052 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003053 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003054 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003055
Cort Stratton7df30962018-05-17 19:45:57 -07003056 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003057 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003058 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003059 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3060 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3061 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003062 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003063 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3064 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003065 // For each region, the number of layers in the image subresource should not be zero
3066 // For each region, src and dest image aspect must be color only
3067 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003068 skip |=
3069 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3070 skip |=
3071 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003072 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003073 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3074 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003075 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003076 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3077 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003078 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3079 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3080 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3081 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3082 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003083 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3084 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003085 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003086 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3087 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003088
3089 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003090 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003091 skip |= LogError(
3092 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003093 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003094 }
Cort Stratton7df30962018-05-17 19:45:57 -07003095 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003096 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3097 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3098 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003099 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003100 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003101 }
3102 }
3103
3104 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3105 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003106 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003107 }
3108 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3109 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003110 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003111 }
3112 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3113 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003114 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003115 }
3116 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3117 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003118 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003119 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003120 } else {
3121 assert(0);
3122 }
3123 return skip;
3124}
3125
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003126bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3127 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003128 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003129 const auto *cb_node = GetCBState(commandBuffer);
3130 const auto *src_image_state = GetImageState(srcImage);
3131 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003132
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003133 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003134 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003135 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003136 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003137 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003138 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003139 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003140 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003141 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003142 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3143 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003144 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003145 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3146 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003147 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003148 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3149 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003150 skip |=
3151 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003152 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3153 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003154 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003155 "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003156 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003157 "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003158
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003159 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003160
Dave Houlton33c2d252017-06-09 17:08:32 -06003161 VkFormat src_format = src_image_state->createInfo.format;
3162 VkFormat dst_format = dst_image_state->createInfo.format;
3163 VkImageType src_type = src_image_state->createInfo.imageType;
3164 VkImageType dst_type = dst_image_state->createInfo.imageType;
3165
Cort Stratton186b1a22018-05-01 20:18:06 -04003166 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003167 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003168 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003169 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003170 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003171 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003172 }
3173
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003174 if (FormatRequiresYcbcrConversion(src_format)) {
3175 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3176 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3177 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3178 string_VkFormat(src_format));
3179 }
3180
3181 if (FormatRequiresYcbcrConversion(dst_format)) {
3182 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3183 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3184 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3185 string_VkFormat(dst_format));
3186 }
3187
Dave Houlton33c2d252017-06-09 17:08:32 -06003188 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003189 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3190 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003191 }
3192
Dave Houlton33c2d252017-06-09 17:08:32 -06003193 // Validate consistency for unsigned formats
3194 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3195 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003196 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003197 << "the other one must also have unsigned integer format. "
3198 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003199 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003200 }
3201
3202 // Validate consistency for signed formats
3203 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3204 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003205 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003206 << "the other one must also have signed integer format. "
3207 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003208 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003209 }
3210
3211 // Validate filter for Depth/Stencil formats
3212 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3213 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003214 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003215 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003216 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003217 }
3218
3219 // Validate aspect bits and formats for depth/stencil images
3220 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3221 if (src_format != dst_format) {
3222 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003223 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003224 << "stencil, the other one must have exactly the same format. "
3225 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3226 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003227 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003228 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003229 } // Depth or Stencil
3230
3231 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003232 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003233 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003234 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3235 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3236 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003237 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003238 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3239 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003240 for (uint32_t i = 0; i < regionCount; i++) {
3241 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003242 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003243 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003244 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3245 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003246 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003247 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3248 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003249 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3250 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3251 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003252 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003253 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003254 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003255 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003256 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3257 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003258 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003259 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3260 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003261 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003262 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3263 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003264 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003265 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003266 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003267 }
Dave Houlton48989f32017-05-26 15:01:46 -06003268 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3269 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003270 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003271 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003272 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003273 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003274
3275 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003276 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003277 skip |= LogError(
3278 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003279 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003280 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003281
Dave Houlton48989f32017-05-26 15:01:46 -06003282 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003283 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3284 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003285 }
Dave Houlton48989f32017-05-26 15:01:46 -06003286
Dave Houlton33c2d252017-06-09 17:08:32 -06003287 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003288 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3289 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3290 "image format %s.",
3291 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003292 }
3293
3294 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003295 skip |= LogError(
3296 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003297 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3298 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003299 }
3300
Dave Houlton48989f32017-05-26 15:01:46 -06003301 // Validate source image offsets
3302 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003303 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003304 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003305 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003306 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3307 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3308 "of (%1d, %1d). These must be (0, 1).",
3309 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003310 }
3311 }
3312
Dave Houlton33c2d252017-06-09 17:08:32 -06003313 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003314 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003315 skip |=
3316 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3317 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3318 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3319 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003320 }
3321 }
3322
Dave Houlton33c2d252017-06-09 17:08:32 -06003323 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003324 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3325 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003326 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003327 skip |= LogError(
3328 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003329 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3330 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003331 }
3332 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3333 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003334 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003335 skip |= LogError(
3336 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003337 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003338 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003339 }
3340 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3341 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003342 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003343 skip |= LogError(
3344 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003345 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3346 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003347 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003348 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003349 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3350 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003351 }
Dave Houlton48989f32017-05-26 15:01:46 -06003352
3353 // Validate dest image offsets
3354 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003355 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003356 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003357 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003358 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3359 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3360 "(%1d, %1d). These must be (0, 1).",
3361 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003362 }
3363 }
3364
Dave Houlton33c2d252017-06-09 17:08:32 -06003365 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003366 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003367 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3368 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3369 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3370 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003371 }
3372 }
3373
Dave Houlton33c2d252017-06-09 17:08:32 -06003374 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003375 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3376 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003377 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003378 skip |= LogError(
3379 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003380 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3381 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003382 }
3383 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3384 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003385 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003386 skip |= LogError(
3387 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003388 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003389 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003390 }
3391 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3392 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003393 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003394 skip |= LogError(
3395 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003396 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3397 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003398 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003399 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003400 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3401 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003402 }
3403
Dave Houlton33c2d252017-06-09 17:08:32 -06003404 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3405 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3406 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003407 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003408 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3409 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3410 "layerCount other than 1.",
3411 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003412 }
3413 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003414 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003415 } else {
3416 assert(0);
3417 }
3418 return skip;
3419}
3420
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003421void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3422 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3423 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003424 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3425 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003426 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003427 auto src_image_state = GetImageState(srcImage);
3428 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003429
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003430 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003431 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003432 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3433 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003434 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003435}
3436
John Zulauf2076e812020-01-08 14:55:54 -07003437GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3438 assert(map);
3439 // This approach allows for a single hash lookup or/create new
3440 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3441 if (inserted.second) {
3442 assert(nullptr == inserted.first->second.get());
3443 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.range_encoder.SubresourceCount());
3444 inserted.first->second.reset(layout_map);
3445 return layout_map;
3446 } else {
3447 assert(nullptr != inserted.first->second.get());
3448 return inserted.first->second.get();
3449 }
3450 return nullptr;
3451}
3452
3453const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3454 auto it = map.find(image);
3455 if (it != map.end()) {
3456 return it->second.get();
3457 }
3458 return nullptr;
3459}
3460
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003461// 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 -07003462bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3463 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003464 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003465 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003466 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003467 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003468 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003469 for (const auto &layout_map_entry : pCB->image_layout_map) {
3470 const auto image = layout_map_entry.first;
3471 const auto *image_state = GetImageState(image);
3472 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003473 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003474 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003475 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003476 if (initial_layout_map.empty()) continue;
3477
3478 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3479 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3480 if (global_map == nullptr) {
3481 global_map = &empty_map;
3482 }
3483
3484 // Note: don't know if it would matter
3485 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3486
3487 auto pos = initial_layout_map.begin();
3488 const auto end = initial_layout_map.end();
3489 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3490 pos->first.begin);
3491 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003492 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003493 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003494 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 -07003495 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003496 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003497 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003498 image_layout = current_layout->pos_B->lower_bound->second;
3499 }
3500 const auto intersected_range = pos->first & current_layout->range;
3501 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3502 // TODO: Set memory invalid which is in mem_tracker currently
3503 } else if (image_layout != initial_layout) {
3504 // Need to look up the inital layout *state* to get a bit more information
3505 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3506 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3507 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3508 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07003509 // We can report all the errors for the intersected range directly
3510 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
3511 const auto subresource = image_state->range_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003512 skip |= LogError(
3513 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003514 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003515 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07003516 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003517 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06003518 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003519 }
3520 }
John Zulauf2076e812020-01-08 14:55:54 -07003521 if (pos->first.includes(intersected_range.end)) {
3522 current_layout.seek(intersected_range.end);
3523 } else {
3524 ++pos;
3525 if (pos != end) {
3526 current_layout.seek(pos->first.begin);
3527 }
3528 }
John Zulauff660ad62019-03-23 07:16:05 -06003529 }
3530
locke-lunargf155ccf2020-02-18 11:34:15 -07003531 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003532 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003533 }
John Zulauff660ad62019-03-23 07:16:05 -06003534
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003535 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003536}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003537
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003538void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003539 for (const auto &layout_map_entry : pCB->image_layout_map) {
3540 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003541 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003542 const auto *image_state = GetImageState(image);
3543 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003544 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3545 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003546 }
3547}
3548
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003549// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003550// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3551// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003552bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3553 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003554 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003555 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003556 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3557
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003558 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07003559 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
3560 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003561 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003562 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3563 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3564 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003565 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
3566 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3567 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07003568 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3569 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
3570 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
3571 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3572 string_VkImageLayout(first_layout));
3573 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3574 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003575 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3576 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3577 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003578 }
3579 }
sfricke-samsung55f01952020-03-24 08:16:41 -07003580
3581 // Same as above for loadOp, but for stencilLoadOp
3582 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3583 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3584 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3585 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
3586 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
3587 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3588 string_VkImageLayout(first_layout));
3589 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3590 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
3591 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
3592 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3593 string_VkImageLayout(first_layout));
3594 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3595 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3596 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
3597 "Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003598 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003599 }
3600 }
3601
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003602 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003603}
3604
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003605bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3606 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003607 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003608 const char *vuid;
3609 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003610
Jason Ekstranda1906302017-12-03 20:16:32 -08003611 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3612 VkFormat format = pCreateInfo->pAttachments[i].format;
3613 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3614 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3615 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003616 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3617 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3618 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3619 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3620 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003621 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003622 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003623 skip |=
3624 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3625 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3626 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3627 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3628 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003629 }
3630 }
3631 }
3632
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003633 // Track when we're observing the first use of an attachment
3634 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3635 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003636 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003637
3638 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3639 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3640 auto attach_index = subpass.pInputAttachments[j].attachment;
3641 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003642 switch (subpass.pInputAttachments[j].layout) {
3643 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3644 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3645 // These are ideal.
3646 break;
3647
3648 case VK_IMAGE_LAYOUT_GENERAL:
3649 // May not be optimal. TODO: reconsider this warning based on other constraints.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003650 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3651 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
Cort Stratton7547f772017-05-04 15:18:52 -07003652 break;
3653
Tobias Hectorbbb12282018-10-22 15:17:59 +01003654 case VK_IMAGE_LAYOUT_UNDEFINED:
3655 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003656 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003657 skip |= LogError(device, vuid,
3658 "Layout for input attachment reference %u in subpass %u is %s but must be "
3659 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3660 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003661 break;
3662
Piers Daniell9af77cd2019-10-16 13:54:12 -06003663 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3664 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3665 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3666 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003667 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003668 skip |= LogError(
3669 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003670 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3671 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3672 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3673 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3674 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003675 skip |= LogError(
3676 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003677 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3678 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3679 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3680 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3681 } else if ((subpass.pInputAttachments[j].aspectMask &
3682 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3683 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3684 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3685 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3686 const auto *attachment_reference_stencil_layout =
3687 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3688 if (attachment_reference_stencil_layout) {
3689 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3690 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3691 attachment_reference_stencil_layout->stencilLayout ==
3692 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3693 attachment_reference_stencil_layout->stencilLayout ==
3694 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3695 attachment_reference_stencil_layout->stencilLayout ==
3696 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3697 attachment_reference_stencil_layout->stencilLayout ==
3698 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3699 attachment_reference_stencil_layout->stencilLayout ==
3700 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3701 attachment_reference_stencil_layout->stencilLayout ==
3702 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3703 attachment_reference_stencil_layout->stencilLayout ==
3704 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3705 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003706 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3707 "In the attachment reference %u in subpass %u with pNext chain instance "
3708 "VkAttachmentReferenceStencilLayoutKHR"
3709 "the stencilLayout member but must not be "
3710 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3711 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3712 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3713 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3714 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3715 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3716 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3717 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3718 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3719 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003720 }
3721 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003722 skip |= LogError(
3723 device, "VUID-VkAttachmentReference2-attachment-03315",
3724 "When the layout for input attachment reference %u in subpass %u is "
3725 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3726 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3727 "VkAttachmentReferenceStencilLayout instance.",
3728 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003729 }
3730 }
3731 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3732 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3733 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003734 skip |= LogError(
3735 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003736 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3737 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3738 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3739 j, i);
3740 }
3741 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3742 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3743 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003744 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3745 "When the aspectMask for input attachment reference %u in subpass %u is "
3746 "VK_IMAGE_ASPECT_STENCIL_BIT "
3747 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3748 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3749 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003750 }
3751 }
3752 break;
3753
Graeme Leese668a9862018-10-08 10:40:02 +01003754 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3755 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003756 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003757 break;
3758 } else {
3759 // Intentionally fall through to generic error message
3760 }
3761 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003762
Cort Stratton7547f772017-05-04 15:18:52 -07003763 default:
3764 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003765 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3766 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3767 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003768 }
3769
Cort Stratton7547f772017-05-04 15:18:52 -07003770 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003771 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3772 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003773
3774 bool used_as_depth =
3775 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3776 bool used_as_color = false;
3777 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3778 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3779 }
3780 if (!used_as_depth && !used_as_color &&
3781 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003782 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003783 skip |= LogError(device, vuid,
3784 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3785 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003786 }
3787 }
3788 attach_first_use[attach_index] = false;
3789 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003790
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003791 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3792 auto attach_index = subpass.pColorAttachments[j].attachment;
3793 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3794
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003795 // TODO: Need a way to validate shared presentable images here, currently just allowing
3796 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3797 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003798 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003799 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003800 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003801 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3802 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003803 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003804
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003805 case VK_IMAGE_LAYOUT_GENERAL:
3806 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003807 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3808 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003809 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003810
Tobias Hectorbbb12282018-10-22 15:17:59 +01003811 case VK_IMAGE_LAYOUT_UNDEFINED:
3812 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003813 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003814 skip |= LogError(device, vuid,
3815 "Layout for color attachment reference %u in subpass %u is %s but should be "
3816 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3817 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003818 break;
3819
Piers Daniell9af77cd2019-10-16 13:54:12 -06003820 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3821 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3822 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3823 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003824 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003825 skip |= LogError(
3826 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003827 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3828 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3829 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3830 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3831 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003832 skip |= LogError(
3833 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003834 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3835 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3836 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3837 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3838 } else if ((subpass.pColorAttachments[j].aspectMask &
3839 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3840 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3841 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3842 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3843 const auto *attachment_reference_stencil_layout =
3844 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3845 if (attachment_reference_stencil_layout) {
3846 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3847 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3848 attachment_reference_stencil_layout->stencilLayout ==
3849 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3850 attachment_reference_stencil_layout->stencilLayout ==
3851 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3852 attachment_reference_stencil_layout->stencilLayout ==
3853 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3854 attachment_reference_stencil_layout->stencilLayout ==
3855 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3856 attachment_reference_stencil_layout->stencilLayout ==
3857 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3858 attachment_reference_stencil_layout->stencilLayout ==
3859 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3860 attachment_reference_stencil_layout->stencilLayout ==
3861 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3862 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003863 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3864 "In the attachment reference %u in subpass %u with pNext chain instance "
3865 "VkAttachmentReferenceStencilLayoutKHR"
3866 "the stencilLayout member but must not be "
3867 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3868 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3869 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3870 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3871 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3872 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3873 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3874 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3875 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3876 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003877 }
3878 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003879 skip |= LogError(
3880 device, "VUID-VkAttachmentReference2-attachment-03315",
3881 "When the layout for color attachment reference %u in subpass %u is "
3882 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3883 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3884 "VkAttachmentReferenceStencilLayout instance.",
3885 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003886 }
3887 }
3888 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3889 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3890 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003891 skip |= LogError(
3892 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003893 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3894 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3895 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3896 j, i);
3897 }
3898 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3899 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3900 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003901 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3902 "When the aspectMask for color attachment reference %u in subpass %u is "
3903 "VK_IMAGE_ASPECT_STENCIL_BIT "
3904 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3905 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3906 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003907 }
3908 }
3909 break;
3910
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003911 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003912 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3913 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3914 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003915 }
3916
John Zulauf4eee2692019-02-09 16:14:25 -07003917 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3918 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3919 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003920 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003921 skip |= LogError(device, vuid,
3922 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
3923 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3924 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003925 }
3926
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003927 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003928 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3929 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003930 }
3931 attach_first_use[attach_index] = false;
3932 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003933
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003934 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3935 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003936 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3937 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3938 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003939 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003940
Dave Houltona9df0ce2018-02-07 10:51:23 -07003941 case VK_IMAGE_LAYOUT_GENERAL:
3942 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3943 // doing a bunch of transitions.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003944 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3945 "GENERAL layout for depth attachment may not give optimal performance.");
Dave Houltona9df0ce2018-02-07 10:51:23 -07003946 break;
3947
Tobias Hectorbbb12282018-10-22 15:17:59 +01003948 case VK_IMAGE_LAYOUT_UNDEFINED:
3949 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003950 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003951 skip |= LogError(device, vuid,
3952 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3953 "layout or GENERAL.",
3954 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003955 break;
3956
Piers Daniell9af77cd2019-10-16 13:54:12 -06003957 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3958 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3959 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3960 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003961 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003962 skip |= LogError(
3963 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003964 "Layout for depth attachment reference in subpass %u is %s but must not be "
3965 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3966 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3967 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3968 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003969 skip |= LogError(
3970 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003971 "Layout for depth attachment reference in subpass %u is %s but must not be "
3972 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3973 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3974 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3975 } else if ((subpass.pDepthStencilAttachment->aspectMask &
3976 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3977 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3978 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3979 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3980 const auto *attachment_reference_stencil_layout =
3981 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
3982 if (attachment_reference_stencil_layout) {
3983 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3984 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3985 attachment_reference_stencil_layout->stencilLayout ==
3986 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3987 attachment_reference_stencil_layout->stencilLayout ==
3988 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3989 attachment_reference_stencil_layout->stencilLayout ==
3990 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3991 attachment_reference_stencil_layout->stencilLayout ==
3992 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3993 attachment_reference_stencil_layout->stencilLayout ==
3994 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3995 attachment_reference_stencil_layout->stencilLayout ==
3996 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3997 attachment_reference_stencil_layout->stencilLayout ==
3998 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3999 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004000 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
4001 "In the attachment reference in subpass %u with pNext chain instance "
4002 "VkAttachmentReferenceStencilLayoutKHR"
4003 "the stencilLayout member but must not be "
4004 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4005 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4006 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4007 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4008 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4009 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4010 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4011 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4012 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
4013 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004014 }
4015 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004016 skip |= LogError(
4017 device, "VUID-VkAttachmentReference2-attachment-03315",
4018 "When the layout for depth attachment reference in subpass %u is "
4019 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4020 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4021 "VkAttachmentReferenceStencilLayout instance.",
4022 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004023 }
4024 }
4025 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4026 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4027 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004028 skip |= LogError(
4029 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004030 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
4031 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4032 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4033 i);
4034 }
4035 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4036 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4037 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004038 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
4039 "When the aspectMask for depth attachment reference in subpass %u is "
4040 "VK_IMAGE_ASPECT_STENCIL_BIT "
4041 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4042 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
4043 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004044 }
4045 }
4046 break;
4047
Dave Houltona9df0ce2018-02-07 10:51:23 -07004048 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4049 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004050 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004051 break;
4052 } else {
4053 // Intentionally fall through to generic error message
4054 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004055 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004056
Dave Houltona9df0ce2018-02-07 10:51:23 -07004057 default:
4058 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004059 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
4060 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4061 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
4062 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004063 }
4064
4065 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4066 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004067 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4068 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004069 }
4070 attach_first_use[attach_index] = false;
4071 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004072 }
4073 return skip;
4074}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004075
Mark Lobodzinski96210742017-02-09 10:33:46 -07004076// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4077// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004078template <typename T1>
4079bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4080 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4081 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004082 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004083 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004084 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004085 if (strict) {
4086 correct_usage = ((actual & desired) == desired);
4087 } else {
4088 correct_usage = ((actual & desired) != 0);
4089 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004090
Mark Lobodzinski96210742017-02-09 10:33:46 -07004091 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004092 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004093 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004094 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
4095 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4096 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004097 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004098 skip = LogError(object, msgCode,
4099 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4100 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004101 }
4102 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004103 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004104}
4105
4106// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4107// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004108bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004109 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004110 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004111 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004112}
4113
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004114bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004115 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004116 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004117 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4118 if ((image_format_features & desired) != desired) {
4119 // Same error, but more details if it was an AHB external format
4120 if (image_state->has_ahb_format == true) {
4121 skip |= LogError(image_state->image, vuid,
4122 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4123 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4124 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004125 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004126 } else {
4127 skip |= LogError(image_state->image, vuid,
4128 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4129 "with tiling %s.",
4130 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4131 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4132 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004133 }
4134 }
4135 return skip;
4136}
4137
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004138bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004139 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004140 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004141 // layerCount must not be zero
4142 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004143 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4144 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004145 }
4146 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4147 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004148 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4149 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004150 }
4151 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4152 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4153 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004154 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4155 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4156 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4157 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004158 }
4159 return skip;
4160}
4161
Mark Lobodzinski96210742017-02-09 10:33:46 -07004162// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4163// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004164bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004165 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004166 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004167 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004168}
4169
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004170bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004171 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004172 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004173
4174 const VkDeviceSize &range = pCreateInfo->range;
4175 if (range != VK_WHOLE_SIZE) {
4176 // Range must be greater than 0
4177 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004178 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
4179 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4180 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4181 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004182 }
4183 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004184 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4185 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004186 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
4187 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4188 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4189 "(%" PRIu32 ").",
4190 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004191 }
4192 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004193 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004194 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
4195 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4196 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4197 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4198 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004199 }
4200 // The sum of range and offset must be less than or equal to the size of buffer
4201 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004202 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
4203 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4204 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4205 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4206 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004207 }
4208 }
4209 return skip;
4210}
4211
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004212bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004213 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004214 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004215 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4216 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004217 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
4218 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4219 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004220 }
4221 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4222 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004223 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
4224 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4225 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004226 }
4227 return skip;
4228}
4229
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004230bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004231 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004232 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004233
Dave Houltond8ed0212018-05-16 17:18:24 -06004234 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004235
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004236 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004237 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4238 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4239 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004240 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004241
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004242 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004243 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4244 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4245 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004246 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004247
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004248 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004249 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4250 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4251 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004252 }
Jeff Bolz87697532019-01-11 22:54:00 -06004253
4254 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4255 if (chained_devaddr_struct) {
4256 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4257 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004258 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4259 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4260 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004261 }
4262 }
4263
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004264 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4265 if (chained_opaqueaddr_struct) {
4266 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4267 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004268 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4269 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4270 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004271 }
4272 }
4273
Shannon McPherson4984e642019-12-05 13:04:34 -07004274 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004275 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4276 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004277 skip |= LogError(
4278 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004279 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4280 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4281 }
4282
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004283 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004284 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4285 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4286 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004287 }
4288
Mark Lobodzinski96210742017-02-09 10:33:46 -07004289 return skip;
4290}
4291
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004292bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004293 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004294 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004295 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004296 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4297 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004298 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004299 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4300 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004301 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004302 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4303 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4304 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004305
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004306 // Buffer view offset must be less than the size of buffer
4307 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004308 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
4309 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4310 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4311 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004312 }
4313
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004314 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004315 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4316 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4317 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004318 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-02749",
4319 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4320 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4321 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004322 }
4323
4324 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4325 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4326 if ((elementSize % 3) == 0) {
4327 elementSize /= 3;
4328 }
4329 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4330 VkDeviceSize alignmentRequirement =
4331 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4332 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4333 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4334 }
4335 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004336 skip |= LogError(
4337 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004338 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4339 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4340 ") must be a multiple of the lesser of "
4341 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4342 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4343 "(%" PRId32
4344 ") is VK_TRUE, the size of a texel of the requested format. "
4345 "If the size of a texel is a multiple of three bytes, then the size of a "
4346 "single component of format is used instead",
4347 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4348 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4349 }
4350 }
4351 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4352 VkDeviceSize alignmentRequirement =
4353 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4354 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4355 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4356 }
4357 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004358 skip |= LogError(
4359 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004360 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4361 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4362 ") must be a multiple of the lesser of "
4363 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4364 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4365 "(%" PRId32
4366 ") is VK_TRUE, the size of a texel of the requested format. "
4367 "If the size of a texel is a multiple of three bytes, then the size of a "
4368 "single component of format is used instead",
4369 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4370 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4371 }
4372 }
4373 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004374
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004375 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004376
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004377 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004378 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004379 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004380}
4381
Mark Lobodzinski602de982017-02-09 11:01:33 -07004382// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004383bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004384 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004385 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004386 const IMAGE_STATE *image_state = GetImageState(image);
4387 // checks color format and (single-plane or non-disjoint)
4388 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
4389 if ((FormatIsColor(format)) &&
4390 ((FormatIsMultiplane(format) == false) || ((image_state->createInfo.flags & VK_IMAGE_CREATE_DISJOINT_BIT) == 0))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004391 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004392 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 -07004393 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004394 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 -07004395 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004396 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004397 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004398 skip |= LogError(image, vuid,
4399 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4400 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4401 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004402 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004403 skip |= LogError(image, vuid,
4404 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4405 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4406 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004407 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004408 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004409 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004410 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 -07004411 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004412 skip |=
4413 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 -07004414 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004415 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004416 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004417 skip |=
4418 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 -07004419 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004420 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4421 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004422 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004423 } else if (FormatIsMultiplane(format)) {
4424 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4425 if (3 == FormatPlaneCount(format)) {
4426 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4427 }
4428 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004429 skip |=
4430 LogError(image, vuid,
4431 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4432 "set, where n = [0, 1, 2].",
4433 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004434 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004435 }
4436 return skip;
4437}
4438
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004439bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4440 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004441 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4442 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004443 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004444
4445 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004446 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004447 skip |= LogError(image, errorCodes.base_mip_err,
4448 "%s: %s.baseMipLevel (= %" PRIu32
4449 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4450 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004451 }
Petr Kraus4d718682017-05-18 03:38:41 +02004452
Petr Krausffa94af2017-08-08 21:46:02 +02004453 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4454 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004455 skip |= LogError(image, errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004456 } else {
4457 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004458
Petr Krausffa94af2017-08-08 21:46:02 +02004459 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004460 skip |= LogError(image, errorCodes.mip_count_err,
4461 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4462 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4463 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4464 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004465 }
Petr Kraus4d718682017-05-18 03:38:41 +02004466 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004467 }
Petr Kraus4d718682017-05-18 03:38:41 +02004468
4469 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004470 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004471 skip |= LogError(image, errorCodes.base_layer_err,
4472 "%s: %s.baseArrayLayer (= %" PRIu32
4473 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4474 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004475 }
Petr Kraus4d718682017-05-18 03:38:41 +02004476
Petr Krausffa94af2017-08-08 21:46:02 +02004477 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4478 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004479 skip |= LogError(image, errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004480 } else {
4481 const uint64_t necessary_layer_count =
4482 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004483
Petr Krausffa94af2017-08-08 21:46:02 +02004484 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004485 skip |= LogError(image, errorCodes.layer_count_err,
4486 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4487 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4488 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4489 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004490 }
Petr Kraus4d718682017-05-18 03:38:41 +02004491 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004492 }
Petr Kraus4d718682017-05-18 03:38:41 +02004493
Mark Lobodzinski602de982017-02-09 11:01:33 -07004494 return skip;
4495}
4496
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004497bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004498 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004499 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004500 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4501 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4502 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4503
4504 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4505 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4506
4507 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004508 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4509 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004510 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004511 : "VUID-VkImageViewCreateInfo-image-01482")
4512 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4513 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004514 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004515 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4516 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004517
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004518 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004519 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004520 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004521}
4522
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004523bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004524 const VkImageSubresourceRange &subresourceRange,
4525 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004526 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004527 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4528 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4529 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4530 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004531
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004532 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004533 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004534 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004535}
4536
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004537bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004538 const VkImageSubresourceRange &subresourceRange,
4539 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004540 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004541 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4542 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4543 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4544 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004545
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004546 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004547 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4548 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004549}
4550
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004551bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004552 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004553 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004554 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004555 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4556 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4557 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4558 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004559
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004560 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004561 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004562}
4563
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004564bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4565 const VkImageUsageFlags image_usage) const {
4566 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4567 bool skip = false;
4568
4569 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4570 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4571
4572 if (image_state->has_ahb_format == true) {
4573 // AHB image view and image share same feature sets
4574 tiling_features = image_state->format_features;
4575 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4576 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4577 assert(device_extensions.vk_ext_image_drm_format_modifier);
4578 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4579 nullptr};
4580 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4581
4582 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4583 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4584 nullptr};
4585 format_properties_2.pNext = (void *)&drm_properties_list;
4586 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4587
4588 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4589 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4590 0) {
4591 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4592 }
4593 }
4594 } else {
4595 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4596 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4597 : format_properties.optimalTilingFeatures;
4598 }
4599
4600 if (tiling_features == 0) {
4601 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4602 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4603 "physical device.",
4604 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4605 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4606 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4607 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4608 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4609 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4610 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4611 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4612 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4613 "VK_IMAGE_USAGE_STORAGE_BIT.",
4614 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4615 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4616 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4617 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4618 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4619 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4620 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4621 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4622 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4623 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4624 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4625 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4626 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4627 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4628 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4629 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4630 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4631 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4632 }
4633
4634 return skip;
4635}
4636
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004637bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004638 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004639 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004640 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004641 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004642 skip |=
4643 ValidateImageUsageFlags(image_state,
4644 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4645 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4646 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4647 false, kVUIDUndefined, "vkCreateImageView()",
4648 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4649 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004650 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004651 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004652 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004653 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004654 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004655 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004656
4657 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4658 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004659 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004660 VkFormat view_format = pCreateInfo->format;
4661 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004662 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004663 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004664
Dave Houltonbd2e2622018-04-10 16:41:14 -06004665 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004666 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004667 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004668 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004669 if (!device_extensions.vk_ext_separate_stencil_usage) {
4670 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004671 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4672 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4673 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004674 }
4675 } else {
4676 const auto image_stencil_struct =
4677 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4678 if (image_stencil_struct == nullptr) {
4679 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004680 skip |= LogError(
4681 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004682 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4683 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4684 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4685 }
4686 } else {
4687 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4688 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4689 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004690 skip |= LogError(
4691 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004692 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4693 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4694 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4695 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4696 }
4697 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4698 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004699 skip |= LogError(
4700 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004701 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4702 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4703 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4704 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4705 }
4706 }
4707 }
4708 }
4709
Dave Houltonbd2e2622018-04-10 16:41:14 -06004710 image_usage = chained_ivuci_struct->usage;
4711 }
4712
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004713 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4714 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004715 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004716 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004717 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004718 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004719 std::stringstream ss;
4720 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004721 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004722 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004723 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004724 }
4725 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004726 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06004727 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4728 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004729 const char *error_vuid;
4730 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4731 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4732 } else if ((device_extensions.vk_khr_maintenance2) &&
4733 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4734 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4735 } else if ((!device_extensions.vk_khr_maintenance2) &&
4736 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4737 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4738 } else {
4739 // both enabled
4740 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4741 }
Dave Houltonc7988072018-04-16 11:46:56 -06004742 std::stringstream ss;
4743 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004744 << " is not in the same format compatibility class as "
4745 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004746 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4747 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004748 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004749 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004750 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004751 }
4752 } else {
4753 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004754 // Unless it is a multi-planar color bit aspect
4755 if ((image_format != view_format) &&
4756 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4757 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4758 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004759 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004760 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004761 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004762 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004763 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004764 }
4765 }
4766
sfricke-samsungd40eda42020-02-09 17:54:31 -08004767 // Validate feature set if using CUBE_ARRAY
4768 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) && (enabled_features.core.imageCubeArray == false)) {
4769 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-viewType-01004",
4770 "vkCreateImageView(): pCreateInfo->viewType can't be VK_IMAGE_VIEW_TYPE_CUBE_ARRAY without "
4771 "enabling the imageCubeArray feature.");
4772 }
4773
Mark Lobodzinski602de982017-02-09 11:01:33 -07004774 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004775 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004776
4777 switch (image_type) {
4778 case VK_IMAGE_TYPE_1D:
4779 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004780 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4781 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4782 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004783 }
4784 break;
4785 case VK_IMAGE_TYPE_2D:
4786 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4787 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4788 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004789 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4790 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4791 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004792 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004793 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4794 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4795 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004796 }
4797 }
4798 break;
4799 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004800 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004801 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4802 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4803 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004804 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004805 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4806 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4807 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004808 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4809 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004810 skip |= LogError(
4811 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4812 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4813 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4814 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4815 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004816 }
4817 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004818 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4819 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4820 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004821 }
4822 }
4823 } else {
4824 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004825 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4826 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4827 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004828 }
4829 }
4830 break;
4831 default:
4832 break;
4833 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004834
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004835 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004836 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004837 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004838 }
4839
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004840 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004841
Jeff Bolz9af91c52018-09-01 21:53:57 -05004842 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4843 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004844 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4845 "vkCreateImageView() If image was created with usage containing "
4846 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4847 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004848 }
4849 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004850 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4851 "vkCreateImageView() If image was created with usage containing "
4852 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004853 }
4854 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004855 }
4856 return skip;
4857}
4858
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004859bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4860 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004861 bool skip = false;
4862
4863 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4864 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4865 VkDeviceSize src_min = UINT64_MAX;
4866 VkDeviceSize src_max = 0;
4867 VkDeviceSize dst_min = UINT64_MAX;
4868 VkDeviceSize dst_max = 0;
4869
4870 for (uint32_t i = 0; i < regionCount; i++) {
4871 src_min = std::min(src_min, pRegions[i].srcOffset);
4872 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4873 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4874 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4875
4876 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4877 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004878 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
4879 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4880 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4881 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004882 }
4883
4884 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4885 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004886 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
4887 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4888 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4889 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004890 }
4891
4892 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4893 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004894 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
4895 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4896 ") is greater than the source buffer size (%" PRIuLEAST64
4897 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4898 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004899 }
4900
4901 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4902 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004903 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
4904 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4905 ") is greater than the destination buffer size (%" PRIuLEAST64
4906 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4907 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004908 }
4909 }
4910
4911 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4912 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4913 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004914 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
4915 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004916 }
4917 }
4918
4919 return skip;
4920}
4921
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004922bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004923 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004924 const auto cb_node = GetCBState(commandBuffer);
4925 const auto src_buffer_state = GetBufferState(srcBuffer);
4926 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004927
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004928 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004929 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4930 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004931 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004932 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004933 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4934 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004935 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004936 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4937 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004938 skip |=
4939 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4940 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004941 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4942 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004943 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004944 return skip;
4945}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004946
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004947bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004948 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004949 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004950 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004951 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
4952 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004953 } else {
4954 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004955 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
4956 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004957 }
4958 }
4959 return skip;
4960}
4961
Jeff Bolz5c801d12019-10-09 10:38:45 -05004962bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4963 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004964 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004965 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004966
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004967 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004968 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004969 skip |=
4970 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004971 }
4972 return skip;
4973}
4974
Jeff Bolz5c801d12019-10-09 10:38:45 -05004975bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004976 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004977
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004978 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004979 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004980 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004981 }
4982 return skip;
4983}
4984
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004985bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004986 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004987 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004988 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004989 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004990 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004991 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004992 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004993 }
4994 return skip;
4995}
4996
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004997bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004998 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004999 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005000 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005001 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005002 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005003 skip |=
5004 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5005 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005006 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005007 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005008 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5009 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005010 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005011
5012 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005013 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5014 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5015 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5016 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005017 }
5018
5019 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005020 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5021 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5022 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5023 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005024 }
5025
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005026 return skip;
5027}
5028
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005029bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
5030 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005031 bool skip = false;
5032
5033 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005034 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5035 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005036 skip |=
5037 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
5038 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5039 "and 1, respectively.",
5040 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005041 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005042 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005043
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005044 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5045 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005046 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
5047 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
5048 "must be 0 and 1, respectively.",
5049 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005050 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005051 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005052
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005053 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5054 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005055 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
5056 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5057 "For 3D images these must be 0 and 1, respectively.",
5058 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005059 }
5060 }
5061
5062 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005063 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07005064 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
5065
Dave Houltona585d132019-01-18 13:05:42 -07005066 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005067 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00193",
5068 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5069 " must be a multiple of this format's texel size (%" PRIu32 ").",
5070 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005071 }
5072
5073 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06005074 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005075 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00194",
5076 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
5077 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005078 }
5079
5080 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5081 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005082 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005083 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
5084 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5085 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005086 }
5087
5088 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5089 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005090 skip |= LogError(
5091 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005092 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5093 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005094 }
5095
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005096 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005097 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005098 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005099 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 -06005100 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5101 static_cast<int32_t>(adjusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005102 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
5103 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5104 "zero or <= image subresource width (%d).",
5105 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005106 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005107 }
5108
5109 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005110 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 -06005111 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5112 static_cast<int32_t>(adjusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005113 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
5114 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5115 "zero or <= image subresource height (%d).",
5116 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005117 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005118 }
5119
5120 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005121 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 -06005122 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5123 static_cast<int32_t>(adjusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005124 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
5125 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5126 "zero or <= image subresource depth (%d).",
5127 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005128 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005129 }
5130
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005131 // subresource aspectMask must have exactly 1 bit set
5132 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
5133 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
5134 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005135 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
5136 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005137 }
5138
5139 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06005140 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005141 skip |= LogError(
5142 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005143 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5144 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005145 }
5146
5147 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04005148 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005149 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005150
5151 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005152 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005153 skip |= LogError(
5154 image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005155 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5156 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005157 }
5158
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005159 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005160 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005161 skip |= LogError(
5162 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005163 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5164 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005165 }
5166
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005167 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005168 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5169 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5170 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005171 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00205",
5172 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5173 "width & height (%d, %d)..",
5174 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5175 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005176 }
5177
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005178 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07005179 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005180 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005181 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00206",
5182 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5183 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5184 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005185 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005186
5187 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005188 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005189 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005190 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005191 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00207",
5192 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5193 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5194 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5195 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005196 }
5197
5198 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005199 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005200 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005201 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00208",
5202 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5203 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5204 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5205 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005206 }
5207
5208 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005209 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005210 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005211 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00209",
5212 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5213 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5214 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5215 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005216 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005217 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005218
5219 // Checks that apply only to multi-planar format images
5220 if (FormatIsMultiplane(image_state->createInfo.format)) {
5221 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5222 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5223 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005224 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5225 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5226 "format has three planes.",
5227 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005228 }
5229
5230 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5231 if (0 == (pRegions[i].imageSubresource.aspectMask &
5232 (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 -07005233 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5234 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5235 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5236 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005237 }
5238 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005239 }
5240
5241 return skip;
5242}
5243
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005244bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5245 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005246 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005247 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005248
5249 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005250 VkExtent3D extent = pRegions[i].imageExtent;
5251 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005252
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005253 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5254 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005255 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5256 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5257 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005258 }
5259
5260 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5261
5262 // 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 -06005263 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005264 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005265 if (image_extent.width % block_extent.width) {
5266 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5267 }
5268 if (image_extent.height % block_extent.height) {
5269 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5270 }
5271 if (image_extent.depth % block_extent.depth) {
5272 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5273 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005274 }
5275
Dave Houltonfc1a4052017-04-27 14:32:45 -06005276 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005277 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005278 }
5279 }
5280
5281 return skip;
5282}
5283
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005284bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5285 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005286 bool skip = false;
5287
5288 VkDeviceSize buffer_size = buff_state->createInfo.size;
5289
5290 for (uint32_t i = 0; i < regionCount; i++) {
5291 VkExtent3D copy_extent = pRegions[i].imageExtent;
5292
5293 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5294 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005295 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5296 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005297
Tom Cooperb2550c72018-10-15 13:08:41 +01005298 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005299 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005300 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005301 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5302 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5303
5304 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5305 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5306 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005307 }
5308
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005309 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5310 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5311 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005312 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005313 } else {
5314 // Calculate buffer offset of final copied byte, + 1.
5315 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5316 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5317 max_buffer_offset *= unit_size; // convert to bytes
5318 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005319
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005320 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005321 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5322 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005323 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005324 }
5325 }
5326
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005327 return skip;
5328}
5329
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005330bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005331 VkBuffer dstBuffer, uint32_t regionCount,
5332 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005333 const auto cb_node = GetCBState(commandBuffer);
5334 const auto src_image_state = GetImageState(srcImage);
5335 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005336
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005337 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005338
5339 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005340 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005341
5342 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005343 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005344
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005345 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005346
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005347 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005348 skip |=
5349 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5350 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5351 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005352 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005353 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005354 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005355 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005356 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005357
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005358 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005359 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005360 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5361 skip |=
5362 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005363
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005364 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005365 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005366 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5367 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005368 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005369 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5370 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005371 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005372 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005373 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005374 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005375 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005376 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005377 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5378 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5379 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005380 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005381 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005382 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005383 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005384 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5385 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005386 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5387 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5388 skip |=
5389 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5390 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5391 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005392 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5393 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005394 }
5395 return skip;
5396}
5397
John Zulauf1686f232019-07-09 16:27:11 -06005398void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5399 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5400 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5401
5402 auto cb_node = GetCBState(commandBuffer);
5403 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005404 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005405 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005406 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005407 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005408}
5409
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005410bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5411 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005412 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005413 const auto cb_node = GetCBState(commandBuffer);
5414 const auto src_buffer_state = GetBufferState(srcBuffer);
5415 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005416
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005417 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005418
5419 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005420 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005421
5422 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005423 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005424 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005425 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005426 skip |=
5427 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5428 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5429 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005430 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005431 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005432 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005433 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005434 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005435 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005436 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005437 skip |=
5438 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5439 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005440 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005441 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5442 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005443 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005444 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5445 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005446 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005447 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005448 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005449 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005450 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005451 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005452 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5453 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5454 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005455 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005456 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005457 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005458 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005459 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5460 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005461 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5462 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5463 skip |=
5464 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5465 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5466 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005467 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5468 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005469 }
5470 return skip;
5471}
5472
John Zulauf1686f232019-07-09 16:27:11 -06005473void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5474 VkImageLayout dstImageLayout, uint32_t regionCount,
5475 const VkBufferImageCopy *pRegions) {
5476 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5477
5478 auto cb_node = GetCBState(commandBuffer);
5479 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005480 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005481 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005482 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005483 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005484}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005485
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005486bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005487 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005488 bool skip = false;
5489 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5490
Dave Houlton1d960ff2018-01-19 12:17:05 -07005491 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005492 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5493 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5494 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005495 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5496 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005497 }
5498
John Zulaufa26d3c82019-08-14 16:09:08 -06005499 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005500 if (!image_entry) {
5501 return skip;
5502 }
5503
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005504 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5505 if (device_extensions.vk_ext_image_drm_format_modifier) {
5506 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5507 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005508 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5509 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5510 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005511 }
5512 } else {
5513 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005514 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5515 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005516 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005517 }
5518
Dave Houlton1d960ff2018-01-19 12:17:05 -07005519 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005520 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005521 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5522 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5523 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005524 }
5525
Dave Houlton1d960ff2018-01-19 12:17:05 -07005526 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005527 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005528 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5529 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5530 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005531 }
5532
Dave Houlton1d960ff2018-01-19 12:17:05 -07005533 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005534 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005535 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5536 if (FormatIsMultiplane(img_format)) {
5537 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5538 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5539 if (FormatPlaneCount(img_format) > 2u) {
5540 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5541 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5542 }
5543 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005544 skip |= LogError(image, vuid,
5545 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5546 ") must be a single-plane specifier flag.",
5547 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005548 }
5549 } else if (FormatIsColor(img_format)) {
5550 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005551 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5552 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5553 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005554 }
5555 } else if (FormatIsDepthOrStencil(img_format)) {
5556 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5557 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005558 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005559 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5560 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5561 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5562 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005563 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5564 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5565 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005566 }
5567 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005568
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005569 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005570 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005571 }
5572
Mike Weiblen672b58b2017-02-21 14:32:53 -07005573 return skip;
5574}