blob: fa7e49048bc13598fc505d2e3c14ba433a38b284 [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
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001313 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001314 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001315 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1316 ") which has "
1317 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1318 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001319 }
1320 }
1321
Dave Houltond9611312018-11-19 17:03:36 -07001322 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001323 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001324 skip |=
1325 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1326 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1327 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001328 }
1329 }
1330
1331 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1332 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1333 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001334 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001335 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1336 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1337 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1338 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001339 }
1340
1341 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001342 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1343 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1344 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1345 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1346 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001347 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001348 }
1349
1350 return skip;
1351}
1352
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001353bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001354 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001355 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001356
1357 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001358 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001359 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1360 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001361 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001362 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001363 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001364
Dave Houltond9611312018-11-19 17:03:36 -07001365 // Chain must include a compatible ycbcr conversion
1366 bool conv_found = false;
1367 uint64_t external_format = 0;
1368 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1369 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001370 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001371 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001372 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001373 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001374 }
Dave Houltond9611312018-11-19 17:03:36 -07001375 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001376 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001377 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001378 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1379 "an externalFormat (%" PRIu64
1380 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1381 "with the same external format.",
1382 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001383 }
1384
1385 // Errors in create_info swizzles
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001386 if (((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1387 (create_info->components.r != VK_COMPONENT_SWIZZLE_R)) ||
1388 ((create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1389 (create_info->components.g != VK_COMPONENT_SWIZZLE_G)) ||
1390 ((create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1391 (create_info->components.b != VK_COMPONENT_SWIZZLE_B)) ||
1392 ((create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1393 (create_info->components.a != VK_COMPONENT_SWIZZLE_A))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001394 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1395 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1396 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001397 }
1398 }
Dave Houltond9611312018-11-19 17:03:36 -07001399
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001400 return skip;
1401}
1402
John Zulaufa26d3c82019-08-14 16:09:08 -06001403bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001404 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001405
John Zulaufa26d3c82019-08-14 16:09:08 -06001406 const IMAGE_STATE *image_state = GetImageState(image);
Spencer Fricke224c9852020-04-06 07:47:29 -07001407 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001408 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1409 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1410 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1411 "bound to memory.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001412 }
1413 return skip;
1414}
1415
1416#else
1417
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001418bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001419 return false;
1420}
1421
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001422bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001423
John Zulaufa26d3c82019-08-14 16:09:08 -06001424bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001425
1426#endif // VK_USE_PLATFORM_ANDROID_KHR
1427
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001428bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001429 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001430 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001431
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001432 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001433 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001434 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1435 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001436 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1437 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001438 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001439 }
1440
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001441 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1442 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001443 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1444 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1445 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001446 }
1447
1448 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001449 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1450 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1451 "height (%d) and arrayLayers (%d) must be >= 6.",
1452 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001453 }
Dave Houlton130c0212018-01-29 13:39:56 -07001454 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001455
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001456 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001457 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1458 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1459 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001460 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1461 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1462 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001463 }
1464
1465 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001466 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1467 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1468 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001469 }
1470
ByumjinConffx991b6062019-08-14 15:17:53 -07001471 if (device_extensions.vk_ext_fragment_density_map) {
1472 uint32_t ceiling_width =
1473 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1474 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1475 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1476 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001477 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1478 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1479 "ceiling of device "
1480 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1481 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1482 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001483 }
1484
1485 uint32_t ceiling_height =
1486 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1487 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1488 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1489 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001490 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1491 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1492 "ceiling of device "
1493 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1494 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1495 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001496 }
1497 }
1498
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001499 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001500 VkResult result = VK_SUCCESS;
1501 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1502 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1503 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1504 &format_limits);
1505 } else {
1506 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1507 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1508 image_format_info.type = pCreateInfo->imageType;
1509 image_format_info.tiling = pCreateInfo->tiling;
1510 image_format_info.usage = pCreateInfo->usage;
1511 image_format_info.flags = pCreateInfo->flags;
1512 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1513 format_limits = image_format_properties.imageFormatProperties;
1514 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001515
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001516 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001517#ifdef VK_USE_PLATFORM_ANDROID_KHR
1518 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1519#endif // VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001520 skip |=
1521 LogError(device, kVUIDUndefined, "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1522 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001523 } else {
1524 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1525 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001526 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1527 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1528 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001529 }
Dave Houlton130c0212018-01-29 13:39:56 -07001530
Dave Houltona585d132019-01-18 13:05:42 -07001531 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1532 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1533 (uint64_t)pCreateInfo->samples;
1534 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001535
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001536 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001537 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001538 uint64_t ig_mask = imageGranularity - 1;
1539 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001540
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001541 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001542 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1543 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1544 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1545 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001546 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001547
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001548 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001549 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1550 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1551 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001552 }
1553
1554 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001555 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1556 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1557 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001558 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001559 }
1560
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001561 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001562 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1563 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1564 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1565 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001566 skip |= LogError(device, error_vuid,
1567 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1568 "YCbCr Conversion format, arrayLayers must be 1",
1569 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001570 }
1571
1572 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001573 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1574 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1575 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001576 }
1577
1578 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001579 skip |= LogError(
1580 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001581 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1582 string_VkSampleCountFlagBits(pCreateInfo->samples));
1583 }
1584
1585 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001586 skip |= LogError(
1587 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001588 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1589 string_VkImageType(pCreateInfo->imageType));
1590 }
1591 }
1592
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001593 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001594 skip |=
1595 LogError(device, "VUID-VkImageCreateInfo-flags-01924",
1596 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1597 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001598 }
1599
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001600 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001601 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001602 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1603 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001604 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1605 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1606 "format must be block, ETC or ASTC compressed, but is %s",
1607 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001608 }
1609 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001610 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1611 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1612 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001613 }
1614 }
1615 }
1616
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001617 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001618 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1619 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1620 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001621 }
1622
unknown2c877272019-07-11 12:56:50 -06001623 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1624 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1625 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001626 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1627 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1628 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001629 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001630 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001631}
1632
John Zulauf7eeb6f72019-06-17 11:56:36 -06001633void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1634 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1635 if (VK_SUCCESS != result) return;
1636
1637 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001638 auto image_state = Get<IMAGE_STATE>(*pImage);
1639 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001640}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001641
Jeff Bolz5c801d12019-10-09 10:38:45 -05001642bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001643 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001644 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001645 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001646 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001647 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001648 }
1649 return skip;
1650}
1651
John Zulauf7eeb6f72019-06-17 11:56:36 -06001652void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1653 // Clean up validation specific data
1654 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001655
locke-lunargcba7d5f2019-12-30 16:59:11 -07001656 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001657
1658 // Clean up generic image state
1659 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001660}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001661
John Zulauf07288512019-07-05 11:09:50 -06001662bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001663 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001664
1665 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1666 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 -07001667 skip |= LogError(image_state->image, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001668 }
1669
Dave Houlton1d2022c2017-03-29 11:43:58 -06001670 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001671 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001672 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001673 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001674 char const str[] = "vkCmdClearColorImage called with compressed image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001675 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001676 }
1677
1678 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1679 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001680 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001681 }
1682 return skip;
1683}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001684
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001685uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1686 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1687 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001688 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001689 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001690 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001691 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001692}
1693
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001694uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1695 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1696 uint32_t array_layer_count = range->layerCount;
1697 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1698 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001699 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001700 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001701}
1702
John Zulauf07288512019-07-05 11:09:50 -06001703bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1704 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1705 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001706 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001707 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1708 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001709 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1710 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1711 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001712 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001713
1714 } else {
1715 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1716 if (!device_extensions.vk_khr_shared_presentable_image) {
1717 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001718 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1719 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1720 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001721 }
1722 } else {
1723 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1724 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001725 skip |= LogError(
1726 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001727 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1728 func_name, string_VkImageLayout(dest_image_layout));
1729 }
1730 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001731 }
1732
John Zulauff660ad62019-03-23 07:16:05 -06001733 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001734 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001735 if (subresource_map) {
1736 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001737 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001738 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001739 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1740 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001741 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1742 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1743 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1744 } else {
1745 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001746 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001747 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1748 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1749 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1750 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001751 }
John Zulauf5e617452019-11-19 14:44:16 -07001752 }
John Zulauff660ad62019-03-23 07:16:05 -06001753 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001754 }
1755
1756 return skip;
1757}
1758
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001759bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1760 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001761 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001762 bool skip = false;
1763 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001764 const auto *cb_node = GetCBState(commandBuffer);
1765 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001766 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001767 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001768 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001769 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001770 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001771 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001772 skip |=
1773 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1774 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001775 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001776 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001777 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001778 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001779 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001780 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1781 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001782 }
sfricke-samsunge775d492020-02-28 09:02:25 -08001783 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
1784 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
1785 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
1786 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
1787 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
1788 string_VkFormat(image_state->createInfo.format));
1789 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001790 }
1791 return skip;
1792}
1793
John Zulaufeabb4462019-07-05 14:13:03 -06001794void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1795 const VkClearColorValue *pColor, uint32_t rangeCount,
1796 const VkImageSubresourceRange *pRanges) {
1797 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1798
1799 auto cb_node = GetCBState(commandBuffer);
1800 auto image_state = GetImageState(image);
1801 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001802 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001803 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001804 }
1805 }
1806}
1807
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001808bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1809 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001810 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001811 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001812
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001813 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001814 const auto *cb_node = GetCBState(commandBuffer);
1815 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001816 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001817 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001818 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001819 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001820 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001821 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001822 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001823 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1824 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001825 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001826 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001827 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001828
1829 bool any_include_aspect_depth_bit = false;
1830 bool any_include_aspect_stencil_bit = false;
1831
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001832 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001833 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001834 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001835 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001836 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001837 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1838 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001839 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001840 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1841 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001842 skip |= LogError(commandBuffer, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001843 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001844 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1845 any_include_aspect_depth_bit = true;
1846 }
1847 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1848 any_include_aspect_stencil_bit = true;
1849 }
1850 }
1851 if (any_include_aspect_stencil_bit) {
1852 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1853 if (image_stencil_struct != nullptr) {
1854 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1855 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001856 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1857 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1858 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1859 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001860 }
1861 } else {
1862 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001863 skip |= LogError(
1864 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05001865 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1866 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1867 "in VkImageCreateInfo::usage used to create image");
1868 }
1869 }
1870 }
1871 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001872 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1873 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1874 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001875 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001876 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001877 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001878 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001879 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001880 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1881 char const str[] =
1882 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1883 "set.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001884 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001885 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001886 }
1887 return skip;
1888}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001889
John Zulaufeabb4462019-07-05 14:13:03 -06001890void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1891 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1892 const VkImageSubresourceRange *pRanges) {
1893 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1894 auto cb_node = GetCBState(commandBuffer);
1895 auto image_state = GetImageState(image);
1896 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001897 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001898 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001899 }
1900 }
1901}
1902
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001903// Returns true if [x, xoffset] and [y, yoffset] overlap
1904static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1905 bool result = false;
1906 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1907 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1908
1909 if (intersection_max > intersection_min) {
1910 result = true;
1911 }
1912 return result;
1913}
1914
Dave Houltonc991cc92018-03-06 11:08:51 -07001915// Returns true if source area of first copy region intersects dest area of second region
1916// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1917static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001918 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001919
Dave Houltonc991cc92018-03-06 11:08:51 -07001920 // Separate planes within a multiplane image cannot intersect
1921 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001922 return result;
1923 }
1924
Dave Houltonc991cc92018-03-06 11:08:51 -07001925 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1926 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1927 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001928 result = true;
1929 switch (type) {
1930 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001931 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001932 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001933 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001934 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001935 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001936 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001937 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001938 break;
1939 default:
1940 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1941 assert(false);
1942 }
1943 }
1944 return result;
1945}
1946
Dave Houltonfc1a4052017-04-27 14:32:45 -06001947// Returns non-zero if offset and extent exceed image extents
1948static const uint32_t x_bit = 1;
1949static const uint32_t y_bit = 2;
1950static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001951static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001952 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001953 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001954 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1955 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001956 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001957 }
1958 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1959 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001960 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001961 }
1962 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1963 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001964 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001965 }
1966 return result;
1967}
1968
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001969// Test if two VkExtent3D structs are equivalent
1970static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1971 bool result = true;
1972 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1973 (extent->depth != other_extent->depth)) {
1974 result = false;
1975 }
1976 return result;
1977}
1978
Dave Houltonee281a52017-12-08 13:51:02 -07001979// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1980// Destination image texel extents must be adjusted by block size for the dest validation checks
1981VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1982 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06001983 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1984 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001985 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001986 adjusted_extent.width /= block_size.width;
1987 adjusted_extent.height /= block_size.height;
1988 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06001989 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1990 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001991 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001992 adjusted_extent.width *= block_size.width;
1993 adjusted_extent.height *= block_size.height;
1994 adjusted_extent.depth *= block_size.depth;
1995 }
1996 return adjusted_extent;
1997}
1998
Dave Houlton6f9059e2017-05-02 17:15:13 -06001999// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002000static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2001 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002002
2003 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002004 if (mip >= img->createInfo.mipLevels) {
2005 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002006 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002007
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002008 // 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 -06002009 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002010
Dave Houltone48cd112019-01-03 17:01:18 -07002011 // If multi-plane, adjust per-plane extent
2012 if (FormatIsMultiplane(img->createInfo.format)) {
2013 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2014 extent.width /= divisors.width;
2015 extent.height /= divisors.height;
2016 }
2017
Jeff Bolzef40fec2018-09-01 22:04:34 -05002018 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2019 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002020 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002021 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2022 } else {
2023 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2024 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2025 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2026 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002027
Dave Houlton6f9059e2017-05-02 17:15:13 -06002028 // Image arrays have an effective z extent that isn't diminished by mip level
2029 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002030 extent.depth = img->createInfo.arrayLayers;
2031 }
2032
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002033 return extent;
2034}
2035
2036// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002037static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002038 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2039}
2040
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002041// Test if the extent argument has any dimensions set to 0.
2042static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2043 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2044}
2045
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002046// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002047VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002048 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2049 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002050 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002051 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002052 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002053 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002054 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002055 granularity.width *= block_size.width;
2056 granularity.height *= block_size.height;
2057 }
2058 }
2059 return granularity;
2060}
2061
2062// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2063static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2064 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002065 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2066 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002067 valid = false;
2068 }
2069 return valid;
2070}
2071
2072// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002073bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002074 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002075 bool skip = false;
2076 VkExtent3D offset_extent = {};
2077 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2078 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2079 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002080 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002081 // 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 -07002082 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002083 skip |= LogError(cb_node->commandBuffer, vuid,
2084 "%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 "
2085 "image transfer granularity is (w=0, h=0, d=0).",
2086 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002087 }
2088 } else {
2089 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2090 // integer multiples of the image transfer granularity.
2091 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002092 skip |= LogError(cb_node->commandBuffer, vuid,
2093 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2094 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2095 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2096 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002097 }
2098 }
2099 return skip;
2100}
2101
2102// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002103bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002104 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002105 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002106 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002107 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002108 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2109 // subresource extent.
2110 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002111 skip |= LogError(cb_node->commandBuffer, vuid,
2112 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2113 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2114 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2115 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002116 }
2117 } else {
2118 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2119 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2120 // subresource extent dimensions.
2121 VkExtent3D offset_extent_sum = {};
2122 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2123 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2124 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002125 bool x_ok = true;
2126 bool y_ok = true;
2127 bool z_ok = true;
2128 switch (image_type) {
2129 case VK_IMAGE_TYPE_3D:
2130 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2131 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002132 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002133 case VK_IMAGE_TYPE_2D:
2134 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2135 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002136 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002137 case VK_IMAGE_TYPE_1D:
2138 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2139 (subresource_extent->width == offset_extent_sum.width));
2140 break;
2141 default:
2142 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2143 assert(false);
2144 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002145 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002146 skip |=
2147 LogError(cb_node->commandBuffer, vuid,
2148 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2149 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2150 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2151 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2152 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2153 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002154 }
2155 }
2156 return skip;
2157}
2158
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002159bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002160 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002161 bool skip = false;
2162 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002163 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2164 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002165 }
2166 return skip;
2167}
2168
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002169bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002170 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002171 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002172 bool skip = false;
2173 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2174 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002175 skip |= LogError(cb_node->commandBuffer, vuid,
2176 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2177 "%u, but provided %s has %u array layers.",
2178 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2179 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002180 }
2181 return skip;
2182}
2183
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002184// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002185bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002186 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002187 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002188 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002189 VkExtent3D granularity = GetScaledItg(cb_node, img);
2190 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002191 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002192 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002193 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002194 return skip;
2195}
2196
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002197// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002198bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002199 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002200 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002201 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002202 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002203 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2204 skip |=
2205 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002206 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002207 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002208 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2209 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002210
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002211 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002212 granularity = GetScaledItg(cb_node, dst_img);
2213 skip |=
2214 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002215 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002216 const VkExtent3D dest_effective_extent =
2217 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002218 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002219 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002220 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002221 return skip;
2222}
2223
Dave Houlton6f9059e2017-05-02 17:15:13 -06002224// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002225bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002226 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002227 bool skip = false;
2228
2229 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002230 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002231
2232 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002233 const VkExtent3D src_copy_extent = region.extent;
2234 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002235 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2236
Dave Houlton6f9059e2017-05-02 17:15:13 -06002237 bool slice_override = false;
2238 uint32_t depth_slices = 0;
2239
2240 // Special case for copying between a 1D/2D array and a 3D image
2241 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2242 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002243 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002244 slice_override = (depth_slices != 1);
2245 } 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 -07002246 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002247 slice_override = (depth_slices != 1);
2248 }
2249
2250 // Do all checks on source image
2251 //
2252 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002253 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002254 skip |=
2255 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2256 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2257 "be 0 and 1, respectively.",
2258 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002259 }
2260 }
2261
Dave Houlton533be9f2018-03-26 17:08:30 -06002262 // VUID-VkImageCopy-srcImage-01785
2263 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 -07002264 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2265 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2266 "these must be 0 and 1, respectively.",
2267 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002268 }
2269
Dave Houlton533be9f2018-03-26 17:08:30 -06002270 // VUID-VkImageCopy-srcImage-01787
2271 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002272 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2273 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2274 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002275 }
2276
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002277 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002278 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002279 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002280 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002281 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2282 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2283 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2284 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002285 }
2286 }
2287 } else { // Pre maint 1
2288 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002289 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002290 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2291 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2292 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2293 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2294 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002295 }
2296 }
2297 }
2298
Dave Houltonc991cc92018-03-06 11:08:51 -07002299 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002300 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002301 if (FormatIsCompressed(src_state->createInfo.format) ||
2302 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002303 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002304 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002305 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2306 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2307 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002308 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002309 skip |= LogError(src_state->image, vuid,
2310 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2311 "texel width & height (%d, %d).",
2312 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002313 }
2314
Dave Houlton94a00372017-12-14 15:08:47 -07002315 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002316 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2317 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002318 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002319 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002320 LogError(src_state->image, vuid,
2321 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2322 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2323 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002324 }
2325
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002326 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002327 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2328 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002329 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002330 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002331 LogError(src_state->image, vuid,
2332 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2333 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2334 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002335 }
2336
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002337 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002338 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2339 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002340 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002341 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002342 LogError(src_state->image, vuid,
2343 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2344 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2345 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002346 }
2347 } // Compressed
2348
2349 // Do all checks on dest image
2350 //
2351 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002352 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002353 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2354 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2355 "these must be 0 and 1, respectively.",
2356 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002357 }
2358 }
2359
Dave Houlton533be9f2018-03-26 17:08:30 -06002360 // VUID-VkImageCopy-dstImage-01786
2361 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 -07002362 skip |=
2363 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2364 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2365 "and 1, respectively.",
2366 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002367 }
2368
2369 // VUID-VkImageCopy-dstImage-01788
2370 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002371 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2372 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2373 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002374 }
2375
2376 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002377 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002378 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2379 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2380 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2381 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002382 }
2383 }
2384 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002385 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002386 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002387 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002388 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002389 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2390 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2391 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2392 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002393 }
2394 }
2395 } else { // Pre maint 1
2396 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002397 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002398 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2399 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2400 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2401 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2402 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002403 }
2404 }
2405 }
2406
Dave Houltonc991cc92018-03-06 11:08:51 -07002407 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2408 if (FormatIsCompressed(dst_state->createInfo.format) ||
2409 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002410 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002411
2412 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002413 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2414 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2415 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002416 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002417 skip |= LogError(dst_state->image, vuid,
2418 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2419 "texel width & height (%d, %d).",
2420 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002421 }
2422
Dave Houlton94a00372017-12-14 15:08:47 -07002423 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002424 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2425 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002426 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002427 skip |= LogError(
2428 dst_state->image, vuid,
2429 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2430 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2431 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002432 }
2433
Dave Houltonee281a52017-12-08 13:51:02 -07002434 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2435 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2436 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002437 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002438 skip |= LogError(dst_state->image, vuid,
2439 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2440 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2441 "height (%d).",
2442 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002443 }
2444
Dave Houltonee281a52017-12-08 13:51:02 -07002445 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2446 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2447 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002448 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002449 skip |= LogError(
2450 dst_state->image, vuid,
2451 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2452 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2453 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002454 }
2455 } // Compressed
2456 }
2457 return skip;
2458}
2459
Dave Houltonc991cc92018-03-06 11:08:51 -07002460// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002461bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002462 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002463 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002464
2465 // Neither image is multiplane
2466 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2467 // If neither image is multi-plane the aspectMask member of src and dst must match
2468 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2469 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002470 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002471 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002472 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002473 }
2474 } else {
2475 // Source image multiplane checks
2476 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2477 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2478 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2479 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002480 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002481 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002482 }
2483 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2484 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2485 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002486 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002487 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002488 }
2489 // Single-plane to multi-plane
2490 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2491 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2492 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002493 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002494 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002495 }
2496
2497 // Dest image multiplane checks
2498 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2499 aspect = region.dstSubresource.aspectMask;
2500 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2501 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002502 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002503 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002504 }
2505 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2506 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2507 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002508 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002509 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002510 }
2511 // Multi-plane to single-plane
2512 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2513 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2514 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002515 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002516 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002517 }
2518 }
2519
2520 return skip;
2521}
2522
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002523bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2524 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002525 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002526 const auto *cb_node = GetCBState(commandBuffer);
2527 const auto *src_image_state = GetImageState(srcImage);
2528 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002529 const VkFormat src_format = src_image_state->createInfo.format;
2530 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002531 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002532
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002533 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002534
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002535 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2536
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002537 for (uint32_t i = 0; i < regionCount; i++) {
2538 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002539
2540 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2541 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002542 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002543
Dave Houlton6f9059e2017-05-02 17:15:13 -06002544 bool slice_override = false;
2545 uint32_t depth_slices = 0;
2546
2547 // Special case for copying between a 1D/2D array and a 3D image
2548 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2549 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2550 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002551 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002552 slice_override = (depth_slices != 1);
2553 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2554 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002555 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002556 slice_override = (depth_slices != 1);
2557 }
2558
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002559 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2560 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2561 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002562 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002563 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002564 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002565 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002566 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2567 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002568 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002569 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2570 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002571
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002572 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002573 // No chance of mismatch if we're overriding depth slice count
2574 if (!slice_override) {
2575 // The number of depth slices in srcSubresource and dstSubresource must match
2576 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2577 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002578 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2579 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002580 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002581 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2582 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002583 if (src_slices != dst_slices) {
2584 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002585 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002586 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002587 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002588 }
2589 }
2590 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002591 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002592 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002593 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002594 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002595 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002596 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002597 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002598 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002599
Dave Houltonc991cc92018-03-06 11:08:51 -07002600 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002601 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002602 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002603 }
2604
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002605 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002606 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2607 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002608 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002609 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002610 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002611 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002612
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002613 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002614 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002615 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002616 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002617 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002618 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002619 }
2620
2621 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002622 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002623 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002624 ss << "vkCmdCopyImage(): pRegion[" << i
2625 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002626 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002627 }
2628
Dave Houltonfc1a4052017-04-27 14:32:45 -06002629 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002630 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2631 if (slice_override) src_copy_extent.depth = depth_slices;
2632 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002633 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002634 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002635 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2636 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2637 "width [%1d].",
2638 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002639 }
2640
2641 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002642 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002643 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2644 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2645 "height [%1d].",
2646 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002647 }
2648 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002649 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002650 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2651 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2652 "depth [%1d].",
2653 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002654 }
2655
Dave Houltonee281a52017-12-08 13:51:02 -07002656 // Adjust dest extent if necessary
2657 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2658 if (slice_override) dst_copy_extent.depth = depth_slices;
2659
2660 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002661 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002662 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2663 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2664 "width [%1d].",
2665 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002666 }
2667 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002668 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2669 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2670 "height [%1d].",
2671 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002672 }
2673 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002674 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2675 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2676 "depth [%1d].",
2677 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002678 }
2679
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002680 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2681 // must not overlap in memory
2682 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002683 for (uint32_t j = 0; j < regionCount; j++) {
2684 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002685 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002686 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002687 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002688 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002689 }
2690 }
2691 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002692
2693 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2694 if (device_extensions.vk_khr_maintenance1) {
2695 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2696 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2697 (src_copy_extent.depth != 1)) {
2698 skip |= LogError(
2699 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2700 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2701 src_copy_extent.depth);
2702 }
2703 } else {
2704 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2705 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2706 (src_copy_extent.depth != 1)) {
2707 skip |= LogError(
2708 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2709 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2710 src_copy_extent.depth);
2711 }
2712 }
2713
2714 // Check if 2D with 3D and depth not equal to 2D layerCount
2715 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2716 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2717 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2718 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2719 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2720 "srcSubresource.layerCount (%u)",
2721 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2722 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2723 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2724 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2725 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2726 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2727 "dstSubresource.layerCount (%u)",
2728 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2729 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002730 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002731
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002732 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2733 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2734 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
sfricke-samsungdce5f692020-03-07 13:59:31 -08002735 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2736 if (src_format != dst_format) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002737 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002738 skip |= LogError(command_buffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002739 }
2740 } else {
sfricke-samsungdce5f692020-03-07 13:59:31 -08002741 if ((!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) && (!FormatIsMultiplane(src_format)) &&
2742 (!FormatIsMultiplane(dst_format))) {
2743 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2744 : "VUID-vkCmdCopyImage-srcImage-00135";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002745 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
sfricke-samsungdce5f692020-03-07 13:59:31 -08002746 skip |= LogError(command_buffer, vuid, "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002747 }
2748 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002749
Dave Houlton33c22b72017-02-28 13:16:02 -07002750 // Source and dest image sample counts must match
2751 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2752 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002753 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002754 }
2755
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002756 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2757 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002758 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002759 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2760 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2761 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2762 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002763 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002764 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2765 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2766 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2767 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002768 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002769 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002770 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002771 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2772 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002773 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002774 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2775 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2776 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2777 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2778 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2779 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002780 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002781 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002782 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2783 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002784 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002785 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2786 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002787 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2788 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002789 }
2790
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002791 return skip;
2792}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002793
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002794void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2795 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2796 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002797 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2798 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002799 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002800 auto src_image_state = GetImageState(srcImage);
2801 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002802
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002803 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002804 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002805 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2806 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002807 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002808}
2809
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002810// Returns true if sub_rect is entirely contained within rect
2811static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2812 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2813 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2814 return false;
2815 return true;
2816}
2817
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002818bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002819 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2820 const VkRect2D &render_area, uint32_t rect_count,
2821 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002822 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002823 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2824 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002825 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002826 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002827
2828 for (uint32_t j = 0; j < rect_count; j++) {
2829 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002830 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2831 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2832 "the current render pass instance.",
2833 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002834 }
2835
2836 if (image_view_state) {
2837 // The layers specified by a given element of pRects must be contained within every attachment that
2838 // pAttachments refers to
2839 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2840 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2841 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002842 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2843 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2844 "of pAttachment[%d].",
2845 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002846 }
2847 }
2848 }
2849 return skip;
2850}
2851
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002852bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2853 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002854 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002855 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002856 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002857 if (!cb_node) return skip;
2858
2859 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2860 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2861 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002862 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002863
2864 // Validate that attachment is in reference list of active subpass
2865 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002866 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002867 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002868 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002869 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002870 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002871
John Zulauf3a548ef2019-02-01 16:14:07 -07002872 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2873 auto clear_desc = &pAttachments[attachment_index];
2874 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002875
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002876 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002877 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002878 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002879 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002880 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002881 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2882 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2883 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2884 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002885 skip |= LogError(
2886 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2887 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2888 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2889 attachment_index, clear_desc->colorAttachment,
2890 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2891 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002892
John Zulauff2582972019-02-09 14:53:30 -07002893 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2894 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002895 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002896 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2897 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
2898 " subpass %u. colorAttachmentCount=%u",
2899 attachment_index, clear_desc->colorAttachment,
2900 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2901 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002902 }
John Zulauff2582972019-02-09 14:53:30 -07002903 fb_attachment = color_attachment;
2904
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002905 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2906 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2907 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002908 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002909 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002910 }
2911 } else { // Must be depth and/or stencil
2912 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2913 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002914 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002915 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002916 }
2917 if (!subpass_desc->pDepthStencilAttachment ||
2918 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002919 skip |= LogPerformanceWarning(
2920 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002921 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002922 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002923 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002924 }
2925 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002926 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002927 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2928 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002929 }
2930 }
2931 }
2932 return skip;
2933}
2934
2935void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2936 const VkClearAttachment *pAttachments, uint32_t rectCount,
2937 const VkClearRect *pRects) {
2938 auto *cb_node = GetCBState(commandBuffer);
2939 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
2940 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2941 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
2942 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
2943 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2944 const auto clear_desc = &pAttachments[attachment_index];
2945 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2946 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
2947 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
2948 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2949 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2950 subpass_desc->pDepthStencilAttachment) {
2951 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
2952 }
2953 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002954 if (!clear_rect_copy) {
2955 // We need a copy of the clear rectangles that will persist until the last lambda executes
2956 // but we want to create it as lazily as possible
2957 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002958 }
John Zulauf441558b2019-08-12 11:47:39 -06002959 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2960 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002961 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06002962 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002963 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06002964 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002965 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2966 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002967 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2968 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002969 return skip;
2970 };
2971 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002972 }
2973 }
2974 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002975}
2976
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002977bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2978 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002979 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002980 const auto *cb_node = GetCBState(commandBuffer);
2981 const auto *src_image_state = GetImageState(srcImage);
2982 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002983
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002984 bool skip = false;
2985 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002986 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2987 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002988 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002989 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002990 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2991 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002992 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2993 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002994
Cort Stratton7df30962018-05-17 19:45:57 -07002995 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002996 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002997 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002998 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2999 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3000 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003001 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003002 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3003 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003004 // For each region, the number of layers in the image subresource should not be zero
3005 // For each region, src and dest image aspect must be color only
3006 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003007 skip |=
3008 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3009 skip |=
3010 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003011 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003012 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3013 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003014 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003015 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3016 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003017 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3018 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3019 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3020 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3021 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003022 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3023 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003024 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003025 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3026 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003027
3028 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003029 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003030 skip |= LogError(
3031 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003032 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003033 }
Cort Stratton7df30962018-05-17 19:45:57 -07003034 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003035 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3036 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3037 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003038 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003039 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003040 }
3041 }
3042
3043 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3044 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003045 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003046 }
3047 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3048 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003049 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003050 }
3051 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3052 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003053 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003054 }
3055 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3056 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003057 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003058 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003059 } else {
3060 assert(0);
3061 }
3062 return skip;
3063}
3064
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003065bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3066 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003067 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003068 const auto *cb_node = GetCBState(commandBuffer);
3069 const auto *src_image_state = GetImageState(srcImage);
3070 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003071
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003072 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003073 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003074 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003075 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003076 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003077 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003078 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003079 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003080 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003081 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3082 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003083 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003084 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3085 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003086 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003087 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3088 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003089 skip |=
3090 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003091 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3092 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003093 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003094 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003095 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003096 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003097
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003098 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003099
Dave Houlton33c2d252017-06-09 17:08:32 -06003100 VkFormat src_format = src_image_state->createInfo.format;
3101 VkFormat dst_format = dst_image_state->createInfo.format;
3102 VkImageType src_type = src_image_state->createInfo.imageType;
3103 VkImageType dst_type = dst_image_state->createInfo.imageType;
3104
Cort Stratton186b1a22018-05-01 20:18:06 -04003105 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003106 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003107 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3108 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003109 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003110 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3111 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3112 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003113 }
3114
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003115 if (FormatRequiresYcbcrConversion(src_format)) {
3116 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3117 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3118 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3119 string_VkFormat(src_format));
3120 }
3121
3122 if (FormatRequiresYcbcrConversion(dst_format)) {
3123 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3124 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3125 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3126 string_VkFormat(dst_format));
3127 }
3128
Dave Houlton33c2d252017-06-09 17:08:32 -06003129 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003130 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3131 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003132 }
3133
Dave Houlton33c2d252017-06-09 17:08:32 -06003134 // Validate consistency for unsigned formats
3135 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3136 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003137 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003138 << "the other one must also have unsigned integer format. "
3139 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003140 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003141 }
3142
3143 // Validate consistency for signed formats
3144 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3145 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003146 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003147 << "the other one must also have signed integer format. "
3148 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003149 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003150 }
3151
3152 // Validate filter for Depth/Stencil formats
3153 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3154 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003155 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003156 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003157 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003158 }
3159
3160 // Validate aspect bits and formats for depth/stencil images
3161 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3162 if (src_format != dst_format) {
3163 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003164 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003165 << "stencil, the other one must have exactly the same format. "
3166 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3167 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003168 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003169 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003170 } // Depth or Stencil
3171
3172 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003173 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003174 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003175 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3176 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3177 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003178 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003179 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3180 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003181 for (uint32_t i = 0; i < regionCount; i++) {
3182 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003183 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003184 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003185 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3186 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003187 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003188 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3189 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003190 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3191 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3192 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003193 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003194 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003195 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003196 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003197 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3198 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003199 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003200 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3201 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003202 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003203 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3204 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003205 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003206 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003207 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003208 }
Dave Houlton48989f32017-05-26 15:01:46 -06003209 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3210 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003211 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003212 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003213 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003214 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003215
3216 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003217 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003218 skip |= LogError(
3219 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003220 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003221 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003222
Dave Houlton48989f32017-05-26 15:01:46 -06003223 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003224 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3225 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003226 }
Dave Houlton48989f32017-05-26 15:01:46 -06003227
Dave Houlton33c2d252017-06-09 17:08:32 -06003228 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003229 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3230 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3231 "image format %s.",
3232 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003233 }
3234
3235 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003236 skip |= LogError(
3237 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003238 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3239 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003240 }
3241
Dave Houlton48989f32017-05-26 15:01:46 -06003242 // Validate source image offsets
3243 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003244 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003245 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003246 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003247 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3248 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3249 "of (%1d, %1d). These must be (0, 1).",
3250 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003251 }
3252 }
3253
Dave Houlton33c2d252017-06-09 17:08:32 -06003254 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003255 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003256 skip |=
3257 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3258 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3259 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3260 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003261 }
3262 }
3263
Dave Houlton33c2d252017-06-09 17:08:32 -06003264 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003265 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3266 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003267 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003268 skip |= LogError(
3269 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003270 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3271 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003272 }
3273 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3274 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003275 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003276 skip |= LogError(
3277 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003278 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003279 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003280 }
3281 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3282 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003283 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003284 skip |= LogError(
3285 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003286 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3287 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003288 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003289 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003290 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3291 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003292 }
Dave Houlton48989f32017-05-26 15:01:46 -06003293
3294 // Validate dest image offsets
3295 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003296 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003297 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003298 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003299 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3300 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3301 "(%1d, %1d). These must be (0, 1).",
3302 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003303 }
3304 }
3305
Dave Houlton33c2d252017-06-09 17:08:32 -06003306 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003307 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003308 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3309 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3310 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3311 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003312 }
3313 }
3314
Dave Houlton33c2d252017-06-09 17:08:32 -06003315 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003316 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3317 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003318 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003319 skip |= LogError(
3320 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003321 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3322 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003323 }
3324 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3325 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
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-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003329 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003330 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003331 }
3332 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3333 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
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-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003337 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3338 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003339 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003340 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003341 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3342 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003343 }
3344
Dave Houlton33c2d252017-06-09 17:08:32 -06003345 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3346 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3347 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003348 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003349 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3350 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3351 "layerCount other than 1.",
3352 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003353 }
3354 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003355 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003356 } else {
3357 assert(0);
3358 }
3359 return skip;
3360}
3361
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003362void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3363 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3364 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003365 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3366 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003367 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003368 auto src_image_state = GetImageState(srcImage);
3369 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003370
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003371 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003372 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003373 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3374 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003375 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003376}
3377
John Zulauf2076e812020-01-08 14:55:54 -07003378GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3379 assert(map);
3380 // This approach allows for a single hash lookup or/create new
3381 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3382 if (inserted.second) {
3383 assert(nullptr == inserted.first->second.get());
3384 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.range_encoder.SubresourceCount());
3385 inserted.first->second.reset(layout_map);
3386 return layout_map;
3387 } else {
3388 assert(nullptr != inserted.first->second.get());
3389 return inserted.first->second.get();
3390 }
3391 return nullptr;
3392}
3393
3394const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3395 auto it = map.find(image);
3396 if (it != map.end()) {
3397 return it->second.get();
3398 }
3399 return nullptr;
3400}
3401
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003402// 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 -07003403bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3404 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003405 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003406 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003407 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003408 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003409 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003410 for (const auto &layout_map_entry : pCB->image_layout_map) {
3411 const auto image = layout_map_entry.first;
3412 const auto *image_state = GetImageState(image);
3413 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003414 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003415 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003416 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003417 if (initial_layout_map.empty()) continue;
3418
3419 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3420 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3421 if (global_map == nullptr) {
3422 global_map = &empty_map;
3423 }
3424
3425 // Note: don't know if it would matter
3426 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3427
3428 auto pos = initial_layout_map.begin();
3429 const auto end = initial_layout_map.end();
3430 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3431 pos->first.begin);
3432 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003433 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003434 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003435 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 -07003436 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003437 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003438 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003439 image_layout = current_layout->pos_B->lower_bound->second;
3440 }
3441 const auto intersected_range = pos->first & current_layout->range;
3442 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3443 // TODO: Set memory invalid which is in mem_tracker currently
3444 } else if (image_layout != initial_layout) {
3445 // Need to look up the inital layout *state* to get a bit more information
3446 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3447 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3448 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3449 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07003450 // We can report all the errors for the intersected range directly
3451 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
3452 const auto subresource = image_state->range_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003453 skip |= LogError(
3454 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003455 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003456 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07003457 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003458 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06003459 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003460 }
3461 }
John Zulauf2076e812020-01-08 14:55:54 -07003462 if (pos->first.includes(intersected_range.end)) {
3463 current_layout.seek(intersected_range.end);
3464 } else {
3465 ++pos;
3466 if (pos != end) {
3467 current_layout.seek(pos->first.begin);
3468 }
3469 }
John Zulauff660ad62019-03-23 07:16:05 -06003470 }
3471
locke-lunargf155ccf2020-02-18 11:34:15 -07003472 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003473 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003474 }
John Zulauff660ad62019-03-23 07:16:05 -06003475
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003476 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003477}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003478
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003479void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003480 for (const auto &layout_map_entry : pCB->image_layout_map) {
3481 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003482 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003483 const auto *image_state = GetImageState(image);
3484 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003485 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3486 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003487 }
3488}
3489
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003490// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003491// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3492// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003493bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3494 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003495 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003496 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003497 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3498
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003499 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07003500 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
3501 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003502 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003503 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3504 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3505 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003506 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
3507 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3508 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07003509 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3510 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
3511 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
3512 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3513 string_VkImageLayout(first_layout));
3514 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3515 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003516 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3517 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3518 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003519 }
3520 }
sfricke-samsung55f01952020-03-24 08:16:41 -07003521
3522 // Same as above for loadOp, but for stencilLoadOp
3523 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3524 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3525 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3526 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
3527 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
3528 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3529 string_VkImageLayout(first_layout));
3530 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3531 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
3532 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
3533 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3534 string_VkImageLayout(first_layout));
3535 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3536 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3537 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
3538 "Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003539 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003540 }
3541 }
3542
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003543 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003544}
3545
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003546bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3547 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003548 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003549 const char *vuid;
3550 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003551
Jason Ekstranda1906302017-12-03 20:16:32 -08003552 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3553 VkFormat format = pCreateInfo->pAttachments[i].format;
3554 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3555 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3556 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003557 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3558 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3559 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3560 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3561 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003562 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003563 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003564 skip |=
3565 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3566 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3567 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3568 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3569 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003570 }
3571 }
3572 }
3573
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003574 // Track when we're observing the first use of an attachment
3575 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3576 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003577 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003578
3579 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3580 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3581 auto attach_index = subpass.pInputAttachments[j].attachment;
3582 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003583 switch (subpass.pInputAttachments[j].layout) {
3584 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3585 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3586 // These are ideal.
3587 break;
3588
3589 case VK_IMAGE_LAYOUT_GENERAL:
3590 // May not be optimal. TODO: reconsider this warning based on other constraints.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003591 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3592 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
Cort Stratton7547f772017-05-04 15:18:52 -07003593 break;
3594
Tobias Hectorbbb12282018-10-22 15:17:59 +01003595 case VK_IMAGE_LAYOUT_UNDEFINED:
3596 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003597 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003598 skip |= LogError(device, vuid,
3599 "Layout for input attachment reference %u in subpass %u is %s but must be "
3600 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3601 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003602 break;
3603
Piers Daniell9af77cd2019-10-16 13:54:12 -06003604 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3605 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3606 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3607 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003608 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003609 skip |= LogError(
3610 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003611 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3612 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3613 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3614 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3615 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003616 skip |= LogError(
3617 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003618 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3619 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3620 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3621 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3622 } else if ((subpass.pInputAttachments[j].aspectMask &
3623 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3624 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3625 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3626 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3627 const auto *attachment_reference_stencil_layout =
3628 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3629 if (attachment_reference_stencil_layout) {
3630 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3631 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3632 attachment_reference_stencil_layout->stencilLayout ==
3633 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3634 attachment_reference_stencil_layout->stencilLayout ==
3635 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3636 attachment_reference_stencil_layout->stencilLayout ==
3637 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3638 attachment_reference_stencil_layout->stencilLayout ==
3639 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3640 attachment_reference_stencil_layout->stencilLayout ==
3641 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3642 attachment_reference_stencil_layout->stencilLayout ==
3643 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3644 attachment_reference_stencil_layout->stencilLayout ==
3645 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3646 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003647 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3648 "In the attachment reference %u in subpass %u with pNext chain instance "
3649 "VkAttachmentReferenceStencilLayoutKHR"
3650 "the stencilLayout member but must not be "
3651 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3652 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3653 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3654 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3655 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3656 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3657 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3658 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3659 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3660 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003661 }
3662 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003663 skip |= LogError(
3664 device, "VUID-VkAttachmentReference2-attachment-03315",
3665 "When the layout for input attachment reference %u in subpass %u is "
3666 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3667 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3668 "VkAttachmentReferenceStencilLayout instance.",
3669 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003670 }
3671 }
3672 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3673 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3674 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003675 skip |= LogError(
3676 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003677 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3678 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3679 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3680 j, i);
3681 }
3682 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3683 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3684 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003685 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3686 "When the aspectMask for input attachment reference %u in subpass %u is "
3687 "VK_IMAGE_ASPECT_STENCIL_BIT "
3688 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3689 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3690 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003691 }
3692 }
3693 break;
3694
Graeme Leese668a9862018-10-08 10:40:02 +01003695 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3696 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003697 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003698 break;
3699 } else {
3700 // Intentionally fall through to generic error message
3701 }
3702 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003703
Cort Stratton7547f772017-05-04 15:18:52 -07003704 default:
3705 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003706 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3707 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3708 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003709 }
3710
Cort Stratton7547f772017-05-04 15:18:52 -07003711 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003712 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3713 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003714
3715 bool used_as_depth =
3716 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3717 bool used_as_color = false;
3718 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3719 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3720 }
3721 if (!used_as_depth && !used_as_color &&
3722 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003723 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003724 skip |= LogError(device, vuid,
3725 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3726 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003727 }
3728 }
3729 attach_first_use[attach_index] = false;
3730 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003731
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003732 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3733 auto attach_index = subpass.pColorAttachments[j].attachment;
3734 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3735
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003736 // TODO: Need a way to validate shared presentable images here, currently just allowing
3737 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3738 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003739 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003740 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003741 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003742 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3743 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003744 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003745
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003746 case VK_IMAGE_LAYOUT_GENERAL:
3747 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003748 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3749 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003750 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003751
Tobias Hectorbbb12282018-10-22 15:17:59 +01003752 case VK_IMAGE_LAYOUT_UNDEFINED:
3753 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003754 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003755 skip |= LogError(device, vuid,
3756 "Layout for color attachment reference %u in subpass %u is %s but should be "
3757 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3758 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003759 break;
3760
Piers Daniell9af77cd2019-10-16 13:54:12 -06003761 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3762 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3763 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3764 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003765 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003766 skip |= LogError(
3767 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003768 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3769 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3770 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3771 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3772 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003773 skip |= LogError(
3774 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003775 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3776 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3777 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3778 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3779 } else if ((subpass.pColorAttachments[j].aspectMask &
3780 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3781 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3782 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3783 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3784 const auto *attachment_reference_stencil_layout =
3785 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3786 if (attachment_reference_stencil_layout) {
3787 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3788 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3789 attachment_reference_stencil_layout->stencilLayout ==
3790 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3791 attachment_reference_stencil_layout->stencilLayout ==
3792 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3793 attachment_reference_stencil_layout->stencilLayout ==
3794 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3795 attachment_reference_stencil_layout->stencilLayout ==
3796 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3797 attachment_reference_stencil_layout->stencilLayout ==
3798 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3799 attachment_reference_stencil_layout->stencilLayout ==
3800 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3801 attachment_reference_stencil_layout->stencilLayout ==
3802 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3803 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003804 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3805 "In the attachment reference %u in subpass %u with pNext chain instance "
3806 "VkAttachmentReferenceStencilLayoutKHR"
3807 "the stencilLayout member but must not be "
3808 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3809 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3810 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3811 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3812 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3813 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3814 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3815 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3816 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3817 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003818 }
3819 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003820 skip |= LogError(
3821 device, "VUID-VkAttachmentReference2-attachment-03315",
3822 "When the layout for color attachment reference %u in subpass %u is "
3823 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3824 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3825 "VkAttachmentReferenceStencilLayout instance.",
3826 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003827 }
3828 }
3829 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3830 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3831 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003832 skip |= LogError(
3833 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003834 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3835 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3836 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3837 j, i);
3838 }
3839 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3840 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3841 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003842 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3843 "When the aspectMask for color attachment reference %u in subpass %u is "
3844 "VK_IMAGE_ASPECT_STENCIL_BIT "
3845 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3846 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3847 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003848 }
3849 }
3850 break;
3851
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003852 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003853 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3854 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3855 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003856 }
3857
John Zulauf4eee2692019-02-09 16:14:25 -07003858 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3859 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3860 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003861 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003862 skip |= LogError(device, vuid,
3863 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
3864 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3865 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003866 }
3867
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003868 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003869 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3870 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003871 }
3872 attach_first_use[attach_index] = false;
3873 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003874
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003875 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3876 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003877 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3878 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3879 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003880 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003881
Dave Houltona9df0ce2018-02-07 10:51:23 -07003882 case VK_IMAGE_LAYOUT_GENERAL:
3883 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3884 // doing a bunch of transitions.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003885 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3886 "GENERAL layout for depth attachment may not give optimal performance.");
Dave Houltona9df0ce2018-02-07 10:51:23 -07003887 break;
3888
Tobias Hectorbbb12282018-10-22 15:17:59 +01003889 case VK_IMAGE_LAYOUT_UNDEFINED:
3890 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003891 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003892 skip |= LogError(device, vuid,
3893 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3894 "layout or GENERAL.",
3895 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003896 break;
3897
Piers Daniell9af77cd2019-10-16 13:54:12 -06003898 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3899 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3900 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3901 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003902 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003903 skip |= LogError(
3904 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003905 "Layout for depth attachment reference in subpass %u is %s but must not be "
3906 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3907 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3908 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3909 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003910 skip |= LogError(
3911 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003912 "Layout for depth attachment reference in subpass %u is %s but must not be "
3913 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3914 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3915 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3916 } else if ((subpass.pDepthStencilAttachment->aspectMask &
3917 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3918 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3919 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3920 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3921 const auto *attachment_reference_stencil_layout =
3922 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
3923 if (attachment_reference_stencil_layout) {
3924 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3925 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3926 attachment_reference_stencil_layout->stencilLayout ==
3927 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3928 attachment_reference_stencil_layout->stencilLayout ==
3929 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3930 attachment_reference_stencil_layout->stencilLayout ==
3931 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3932 attachment_reference_stencil_layout->stencilLayout ==
3933 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3934 attachment_reference_stencil_layout->stencilLayout ==
3935 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3936 attachment_reference_stencil_layout->stencilLayout ==
3937 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3938 attachment_reference_stencil_layout->stencilLayout ==
3939 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3940 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003941 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3942 "In the attachment reference in subpass %u with pNext chain instance "
3943 "VkAttachmentReferenceStencilLayoutKHR"
3944 "the stencilLayout member but must not be "
3945 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3946 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3947 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3948 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3949 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3950 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3951 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3952 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3953 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3954 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003955 }
3956 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003957 skip |= LogError(
3958 device, "VUID-VkAttachmentReference2-attachment-03315",
3959 "When the layout for depth attachment reference in subpass %u is "
3960 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3961 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3962 "VkAttachmentReferenceStencilLayout instance.",
3963 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003964 }
3965 }
3966 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3967 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3968 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003969 skip |= LogError(
3970 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003971 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3972 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3973 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3974 i);
3975 }
3976 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3977 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3978 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003979 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3980 "When the aspectMask for depth attachment reference in subpass %u is "
3981 "VK_IMAGE_ASPECT_STENCIL_BIT "
3982 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3983 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3984 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003985 }
3986 }
3987 break;
3988
Dave Houltona9df0ce2018-02-07 10:51:23 -07003989 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3990 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003991 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003992 break;
3993 } else {
3994 // Intentionally fall through to generic error message
3995 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003996 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003997
Dave Houltona9df0ce2018-02-07 10:51:23 -07003998 default:
3999 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004000 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
4001 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4002 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
4003 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004004 }
4005
4006 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4007 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004008 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4009 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004010 }
4011 attach_first_use[attach_index] = false;
4012 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004013 }
4014 return skip;
4015}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004016
Mark Lobodzinski96210742017-02-09 10:33:46 -07004017// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4018// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004019template <typename T1>
4020bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4021 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4022 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004023 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004024 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004025 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004026 if (strict) {
4027 correct_usage = ((actual & desired) == desired);
4028 } else {
4029 correct_usage = ((actual & desired) != 0);
4030 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004031
Mark Lobodzinski96210742017-02-09 10:33:46 -07004032 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004033 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004034 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004035 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
4036 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4037 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004038 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004039 skip = LogError(object, msgCode,
4040 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4041 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004042 }
4043 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004044 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004045}
4046
4047// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4048// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004049bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004050 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004051 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004052 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004053}
4054
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004055bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06004056 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004057 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04004058 bool skip = false;
4059 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
4060 if ((format_properties.linearTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004061 skip |=
4062 LogError(image_state->image, linear_vuid, "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.",
4063 func_name, format_properties.linearTilingFeatures, image_state->createInfo.format,
4064 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004065 }
4066 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
4067 if ((format_properties.optimalTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004068 skip |= LogError(image_state->image, optimal_vuid,
4069 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
4070 format_properties.optimalTilingFeatures, image_state->createInfo.format,
4071 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004072 }
4073 }
4074 return skip;
4075}
4076
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004077bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004078 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004079 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004080 // layerCount must not be zero
4081 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004082 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4083 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004084 }
4085 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4086 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004087 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4088 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004089 }
4090 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4091 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4092 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004093 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4094 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4095 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4096 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004097 }
4098 return skip;
4099}
4100
Mark Lobodzinski96210742017-02-09 10:33:46 -07004101// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4102// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004103bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004104 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004105 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004106 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004107}
4108
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004109bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004110 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004111 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004112
4113 const VkDeviceSize &range = pCreateInfo->range;
4114 if (range != VK_WHOLE_SIZE) {
4115 // Range must be greater than 0
4116 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004117 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
4118 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4119 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4120 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004121 }
4122 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004123 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4124 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004125 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
4126 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4127 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4128 "(%" PRIu32 ").",
4129 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004130 }
4131 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004132 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004133 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
4134 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4135 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4136 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4137 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004138 }
4139 // The sum of range and offset must be less than or equal to the size of buffer
4140 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004141 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
4142 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4143 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4144 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4145 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004146 }
4147 }
4148 return skip;
4149}
4150
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004151bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004152 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004153 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004154 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4155 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004156 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
4157 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4158 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004159 }
4160 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4161 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004162 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
4163 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4164 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004165 }
4166 return skip;
4167}
4168
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004169bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004170 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004171 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004172
Dave Houltond8ed0212018-05-16 17:18:24 -06004173 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004174
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004175 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004176 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4177 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4178 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004179 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004180
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004181 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004182 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4183 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4184 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004185 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004186
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004187 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004188 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4189 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4190 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004191 }
Jeff Bolz87697532019-01-11 22:54:00 -06004192
4193 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4194 if (chained_devaddr_struct) {
4195 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4196 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004197 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4198 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4199 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004200 }
4201 }
4202
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004203 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4204 if (chained_opaqueaddr_struct) {
4205 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4206 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004207 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4208 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4209 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004210 }
4211 }
4212
Shannon McPherson4984e642019-12-05 13:04:34 -07004213 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004214 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4215 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004216 skip |= LogError(
4217 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004218 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4219 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4220 }
4221
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004222 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004223 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4224 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4225 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004226 }
4227
Mark Lobodzinski96210742017-02-09 10:33:46 -07004228 return skip;
4229}
4230
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004231bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004232 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004233 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004234 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004235 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4236 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004237 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004238 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4239 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004240 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004241 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4242 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4243 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004244
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004245 // Buffer view offset must be less than the size of buffer
4246 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004247 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
4248 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4249 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4250 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004251 }
4252
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004253 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004254 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4255 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4256 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004257 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-02749",
4258 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4259 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4260 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004261 }
4262
4263 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4264 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4265 if ((elementSize % 3) == 0) {
4266 elementSize /= 3;
4267 }
4268 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4269 VkDeviceSize alignmentRequirement =
4270 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4271 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4272 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4273 }
4274 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004275 skip |= LogError(
4276 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004277 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4278 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4279 ") must be a multiple of the lesser of "
4280 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4281 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4282 "(%" PRId32
4283 ") is VK_TRUE, the size of a texel of the requested format. "
4284 "If the size of a texel is a multiple of three bytes, then the size of a "
4285 "single component of format is used instead",
4286 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4287 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4288 }
4289 }
4290 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4291 VkDeviceSize alignmentRequirement =
4292 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4293 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4294 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4295 }
4296 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004297 skip |= LogError(
4298 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004299 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4300 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4301 ") must be a multiple of the lesser of "
4302 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4303 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4304 "(%" PRId32
4305 ") is VK_TRUE, the size of a texel of the requested format. "
4306 "If the size of a texel is a multiple of three bytes, then the size of a "
4307 "single component of format is used instead",
4308 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4309 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4310 }
4311 }
4312 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004313
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004314 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004315
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004316 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004317 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004318 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004319}
4320
Mark Lobodzinski602de982017-02-09 11:01:33 -07004321// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004322bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004323 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004324 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004325 const IMAGE_STATE *image_state = GetImageState(image);
4326 // checks color format and (single-plane or non-disjoint)
4327 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
4328 if ((FormatIsColor(format)) &&
4329 ((FormatIsMultiplane(format) == false) || ((image_state->createInfo.flags & VK_IMAGE_CREATE_DISJOINT_BIT) == 0))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004330 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004331 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 -07004332 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004333 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 -07004334 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004335 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004336 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004337 skip |= LogError(image, vuid,
4338 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4339 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4340 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004341 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004342 skip |= LogError(image, vuid,
4343 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4344 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4345 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004346 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004347 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004348 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004349 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 -07004350 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004351 skip |=
4352 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 -07004353 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004354 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004355 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004356 skip |=
4357 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 -07004358 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004359 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4360 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004361 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004362 } else if (FormatIsMultiplane(format)) {
4363 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4364 if (3 == FormatPlaneCount(format)) {
4365 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4366 }
4367 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004368 skip |=
4369 LogError(image, vuid,
4370 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4371 "set, where n = [0, 1, 2].",
4372 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004373 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004374 }
4375 return skip;
4376}
4377
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004378bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4379 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004380 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4381 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004382 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004383
4384 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004385 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004386 skip |= LogError(image, errorCodes.base_mip_err,
4387 "%s: %s.baseMipLevel (= %" PRIu32
4388 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4389 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004390 }
Petr Kraus4d718682017-05-18 03:38:41 +02004391
Petr Krausffa94af2017-08-08 21:46:02 +02004392 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4393 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004394 skip |= LogError(image, errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004395 } else {
4396 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004397
Petr Krausffa94af2017-08-08 21:46:02 +02004398 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004399 skip |= LogError(image, errorCodes.mip_count_err,
4400 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4401 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4402 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4403 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004404 }
Petr Kraus4d718682017-05-18 03:38:41 +02004405 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004406 }
Petr Kraus4d718682017-05-18 03:38:41 +02004407
4408 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004409 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004410 skip |= LogError(image, errorCodes.base_layer_err,
4411 "%s: %s.baseArrayLayer (= %" PRIu32
4412 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4413 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004414 }
Petr Kraus4d718682017-05-18 03:38:41 +02004415
Petr Krausffa94af2017-08-08 21:46:02 +02004416 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4417 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004418 skip |= LogError(image, errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004419 } else {
4420 const uint64_t necessary_layer_count =
4421 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004422
Petr Krausffa94af2017-08-08 21:46:02 +02004423 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004424 skip |= LogError(image, errorCodes.layer_count_err,
4425 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4426 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4427 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4428 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004429 }
Petr Kraus4d718682017-05-18 03:38:41 +02004430 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004431 }
Petr Kraus4d718682017-05-18 03:38:41 +02004432
Mark Lobodzinski602de982017-02-09 11:01:33 -07004433 return skip;
4434}
4435
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004436bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004437 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004438 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004439 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4440 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4441 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4442
4443 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4444 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4445
4446 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004447 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4448 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004449 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004450 : "VUID-VkImageViewCreateInfo-image-01482")
4451 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4452 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004453 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004454 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4455 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004456
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004457 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004458 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004459 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004460}
4461
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004462bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004463 const VkImageSubresourceRange &subresourceRange,
4464 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004465 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004466 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4467 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4468 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4469 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004470
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004471 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004472 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004473 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004474}
4475
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004476bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004477 const VkImageSubresourceRange &subresourceRange,
4478 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004479 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004480 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4481 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4482 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4483 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004484
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004485 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004486 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4487 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004488}
4489
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004490bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004491 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004492 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004493 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004494 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4495 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4496 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4497 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004498
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004499 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004500 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004501}
4502
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004503bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004504 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004505 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004506 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004507 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004508 skip |=
4509 ValidateImageUsageFlags(image_state,
4510 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4511 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4512 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4513 false, kVUIDUndefined, "vkCreateImageView()",
4514 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4515 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004516 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004517 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004518 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004519 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004520 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004521 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004522
4523 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4524 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004525 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4526 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004527 VkFormat view_format = pCreateInfo->format;
4528 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004529 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004530 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004531
Dave Houltonbd2e2622018-04-10 16:41:14 -06004532 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004533 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004534 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004535 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004536 if (!device_extensions.vk_ext_separate_stencil_usage) {
4537 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004538 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4539 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4540 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004541 }
4542 } else {
4543 const auto image_stencil_struct =
4544 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4545 if (image_stencil_struct == nullptr) {
4546 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004547 skip |= LogError(
4548 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004549 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4550 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4551 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4552 }
4553 } else {
4554 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4555 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4556 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004557 skip |= LogError(
4558 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004559 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4560 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4561 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4562 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4563 }
4564 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4565 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004566 skip |= LogError(
4567 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004568 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4569 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4570 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4571 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4572 }
4573 }
4574 }
4575 }
4576
Dave Houltonbd2e2622018-04-10 16:41:14 -06004577 image_usage = chained_ivuci_struct->usage;
4578 }
4579
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004580 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4581 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004582 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004583 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004584 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004585 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004586 std::stringstream ss;
4587 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004588 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004589 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004590 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004591 }
4592 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004593 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06004594 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4595 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004596 const char *error_vuid;
4597 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4598 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4599 } else if ((device_extensions.vk_khr_maintenance2) &&
4600 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4601 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4602 } else if ((!device_extensions.vk_khr_maintenance2) &&
4603 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4604 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4605 } else {
4606 // both enabled
4607 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4608 }
Dave Houltonc7988072018-04-16 11:46:56 -06004609 std::stringstream ss;
4610 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004611 << " is not in the same format compatibility class as "
4612 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004613 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4614 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004615 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004616 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004617 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004618 }
4619 } else {
4620 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004621 // Unless it is a multi-planar color bit aspect
4622 if ((image_format != view_format) &&
4623 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4624 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4625 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004626 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004627 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004628 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004629 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004630 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004631 }
4632 }
4633
sfricke-samsungd40eda42020-02-09 17:54:31 -08004634 // Validate feature set if using CUBE_ARRAY
4635 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) && (enabled_features.core.imageCubeArray == false)) {
4636 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-viewType-01004",
4637 "vkCreateImageView(): pCreateInfo->viewType can't be VK_IMAGE_VIEW_TYPE_CUBE_ARRAY without "
4638 "enabling the imageCubeArray feature.");
4639 }
4640
Mark Lobodzinski602de982017-02-09 11:01:33 -07004641 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004642 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004643
4644 switch (image_type) {
4645 case VK_IMAGE_TYPE_1D:
4646 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004647 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4648 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4649 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004650 }
4651 break;
4652 case VK_IMAGE_TYPE_2D:
4653 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4654 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4655 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004656 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4657 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4658 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004659 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004660 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4661 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4662 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004663 }
4664 }
4665 break;
4666 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004667 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004668 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4669 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4670 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004671 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004672 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4673 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4674 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004675 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4676 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004677 skip |= LogError(
4678 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4679 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4680 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4681 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4682 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004683 }
4684 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004685 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4686 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4687 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004688 }
4689 }
4690 } else {
4691 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004692 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4693 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4694 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004695 }
4696 }
4697 break;
4698 default:
4699 break;
4700 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004701
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004702 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004703 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004704 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004705 }
4706
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004707 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004708 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4709 : format_properties.optimalTilingFeatures;
4710
4711 if (tiling_features == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004712 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-None-02273",
4713 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4714 "physical device.",
4715 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004716 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004717 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02274",
4718 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4719 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4720 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004721 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004722 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02275",
4723 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4724 "VK_IMAGE_USAGE_STORAGE_BIT.",
4725 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004726 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4727 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004728 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02276",
4729 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4730 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4731 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004732 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4733 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004734 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02277",
4735 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4736 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4737 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
sfricke-samsungd40eda42020-02-09 17:54:31 -08004738 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4739 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4740 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02652",
4741 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4742 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4743 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004744 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004745
Jeff Bolz9af91c52018-09-01 21:53:57 -05004746 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4747 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004748 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4749 "vkCreateImageView() If image was created with usage containing "
4750 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4751 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004752 }
4753 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004754 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4755 "vkCreateImageView() If image was created with usage containing "
4756 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004757 }
4758 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004759 }
4760 return skip;
4761}
4762
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004763bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4764 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004765 bool skip = false;
4766
4767 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4768 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4769 VkDeviceSize src_min = UINT64_MAX;
4770 VkDeviceSize src_max = 0;
4771 VkDeviceSize dst_min = UINT64_MAX;
4772 VkDeviceSize dst_max = 0;
4773
4774 for (uint32_t i = 0; i < regionCount; i++) {
4775 src_min = std::min(src_min, pRegions[i].srcOffset);
4776 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4777 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4778 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4779
4780 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4781 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004782 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
4783 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4784 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4785 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004786 }
4787
4788 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4789 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004790 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
4791 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4792 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4793 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004794 }
4795
4796 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4797 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004798 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
4799 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4800 ") is greater than the source buffer size (%" PRIuLEAST64
4801 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4802 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004803 }
4804
4805 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4806 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004807 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
4808 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4809 ") is greater than the destination buffer size (%" PRIuLEAST64
4810 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4811 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004812 }
4813 }
4814
4815 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4816 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4817 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004818 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
4819 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004820 }
4821 }
4822
4823 return skip;
4824}
4825
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004826bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004827 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004828 const auto cb_node = GetCBState(commandBuffer);
4829 const auto src_buffer_state = GetBufferState(srcBuffer);
4830 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004831
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004832 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004833 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4834 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004835 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004836 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004837 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4838 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004839 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004840 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4841 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004842 skip |=
4843 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4844 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004845 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4846 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004847 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004848 return skip;
4849}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004850
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004851bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004852 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004853 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004854 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004855 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
4856 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004857 } else {
4858 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004859 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
4860 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004861 }
4862 }
4863 return skip;
4864}
4865
Jeff Bolz5c801d12019-10-09 10:38:45 -05004866bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4867 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004868 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004869 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004870
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004871 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004872 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004873 skip |=
4874 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004875 }
4876 return skip;
4877}
4878
Jeff Bolz5c801d12019-10-09 10:38:45 -05004879bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004880 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004881
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004882 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004883 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004884 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004885 }
4886 return skip;
4887}
4888
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004889bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004890 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004891 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004892 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004893 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004894 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004895 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004896 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004897 }
4898 return skip;
4899}
4900
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004901bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004902 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004903 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004904 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004905 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004906 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004907 skip |=
4908 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4909 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004910 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004911 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004912 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4913 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004914 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004915
4916 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004917 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
4918 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
4919 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
4920 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004921 }
4922
4923 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004924 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
4925 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
4926 ") minus dstOffset (0x%" PRIxLEAST64 ").",
4927 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004928 }
4929
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004930 return skip;
4931}
4932
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004933bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
4934 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004935 bool skip = false;
4936
4937 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004938 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4939 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004940 skip |=
4941 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
4942 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
4943 "and 1, respectively.",
4944 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004945 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004946 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004947
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004948 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4949 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004950 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
4951 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
4952 "must be 0 and 1, respectively.",
4953 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004954 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004955 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004956
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004957 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4958 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004959 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
4960 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4961 "For 3D images these must be 0 and 1, respectively.",
4962 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004963 }
4964 }
4965
4966 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004967 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004968 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4969
Dave Houltona585d132019-01-18 13:05:42 -07004970 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004971 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00193",
4972 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
4973 " must be a multiple of this format's texel size (%" PRIu32 ").",
4974 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004975 }
4976
4977 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004978 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004979 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00194",
4980 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4981 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004982 }
4983
4984 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4985 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004986 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004987 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
4988 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4989 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004990 }
4991
4992 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4993 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004994 skip |= LogError(
4995 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004996 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4997 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004998 }
4999
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005000 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005001 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005002 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005003 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 -06005004 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5005 static_cast<int32_t>(adjusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005006 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
5007 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5008 "zero or <= image subresource width (%d).",
5009 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005010 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005011 }
5012
5013 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005014 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 -06005015 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5016 static_cast<int32_t>(adjusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005017 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
5018 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5019 "zero or <= image subresource height (%d).",
5020 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005021 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005022 }
5023
5024 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005025 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 -06005026 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5027 static_cast<int32_t>(adjusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005028 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
5029 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5030 "zero or <= image subresource depth (%d).",
5031 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005032 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005033 }
5034
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005035 // subresource aspectMask must have exactly 1 bit set
5036 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
5037 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
5038 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005039 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
5040 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005041 }
5042
5043 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06005044 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005045 skip |= LogError(
5046 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005047 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5048 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005049 }
5050
5051 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04005052 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005053 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005054
5055 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005056 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005057 skip |= LogError(
5058 image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005059 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5060 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005061 }
5062
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005063 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005064 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005065 skip |= LogError(
5066 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005067 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5068 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005069 }
5070
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005071 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005072 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5073 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5074 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005075 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00205",
5076 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5077 "width & height (%d, %d)..",
5078 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5079 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005080 }
5081
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005082 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07005083 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005084 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005085 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00206",
5086 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5087 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5088 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005089 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005090
5091 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005092 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005093 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005094 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005095 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00207",
5096 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5097 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5098 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5099 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005100 }
5101
5102 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005103 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005104 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005105 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00208",
5106 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5107 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5108 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5109 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005110 }
5111
5112 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005113 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005114 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005115 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00209",
5116 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5117 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5118 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5119 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005120 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005121 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005122
5123 // Checks that apply only to multi-planar format images
5124 if (FormatIsMultiplane(image_state->createInfo.format)) {
5125 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5126 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5127 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005128 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5129 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5130 "format has three planes.",
5131 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005132 }
5133
5134 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5135 if (0 == (pRegions[i].imageSubresource.aspectMask &
5136 (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 -07005137 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5138 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5139 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5140 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005141 }
5142 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005143 }
5144
5145 return skip;
5146}
5147
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005148bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5149 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005150 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005151 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005152
5153 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005154 VkExtent3D extent = pRegions[i].imageExtent;
5155 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005156
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005157 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5158 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005159 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5160 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5161 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005162 }
5163
5164 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5165
5166 // 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 -06005167 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005168 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005169 if (image_extent.width % block_extent.width) {
5170 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5171 }
5172 if (image_extent.height % block_extent.height) {
5173 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5174 }
5175 if (image_extent.depth % block_extent.depth) {
5176 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5177 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005178 }
5179
Dave Houltonfc1a4052017-04-27 14:32:45 -06005180 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005181 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005182 }
5183 }
5184
5185 return skip;
5186}
5187
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005188bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5189 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005190 bool skip = false;
5191
5192 VkDeviceSize buffer_size = buff_state->createInfo.size;
5193
5194 for (uint32_t i = 0; i < regionCount; i++) {
5195 VkExtent3D copy_extent = pRegions[i].imageExtent;
5196
5197 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5198 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005199 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5200 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005201
Tom Cooperb2550c72018-10-15 13:08:41 +01005202 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005203 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005204 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005205 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5206 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5207
5208 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5209 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5210 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005211 }
5212
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005213 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5214 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5215 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005216 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005217 } else {
5218 // Calculate buffer offset of final copied byte, + 1.
5219 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5220 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5221 max_buffer_offset *= unit_size; // convert to bytes
5222 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005223
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005224 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005225 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5226 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005227 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005228 }
5229 }
5230
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005231 return skip;
5232}
5233
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005234bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005235 VkBuffer dstBuffer, uint32_t regionCount,
5236 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005237 const auto cb_node = GetCBState(commandBuffer);
5238 const auto src_image_state = GetImageState(srcImage);
5239 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005240
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005241 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005242
5243 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005244 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005245
5246 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005247 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005248
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005249 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005250
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005251 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005252 skip |=
5253 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5254 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5255 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005256 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005257 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005258 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005259 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005260 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005261
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005262 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005263 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005264 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5265 skip |=
5266 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005267
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005268 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005269 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005270 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5271 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005272 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005273 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5274 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005275 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005276 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5277 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005278 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005279 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005280 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005281 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005282 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5283 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5284 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005285 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005286 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005287 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005288 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005289 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5290 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005291 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5292 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5293 skip |=
5294 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5295 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5296 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005297 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5298 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005299 }
5300 return skip;
5301}
5302
John Zulauf1686f232019-07-09 16:27:11 -06005303void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5304 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5305 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5306
5307 auto cb_node = GetCBState(commandBuffer);
5308 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005309 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005310 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005311 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005312 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005313}
5314
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005315bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5316 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005317 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005318 const auto cb_node = GetCBState(commandBuffer);
5319 const auto src_buffer_state = GetBufferState(srcBuffer);
5320 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005321
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005322 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005323
5324 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005325 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005326
5327 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005328 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005329 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005330 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005331 skip |=
5332 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5333 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5334 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005335 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005336 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005337 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005338 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005339 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005340 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005341 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005342 skip |=
5343 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5344 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005345 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005346 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5347 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005348 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005349 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5350 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005351 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005352 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5353 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005354 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005355 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005356 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005357 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005358 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5359 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5360 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005361 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005362 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005363 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005364 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005365 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5366 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005367 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5368 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5369 skip |=
5370 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5371 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5372 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005373 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5374 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005375 }
5376 return skip;
5377}
5378
John Zulauf1686f232019-07-09 16:27:11 -06005379void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5380 VkImageLayout dstImageLayout, uint32_t regionCount,
5381 const VkBufferImageCopy *pRegions) {
5382 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5383
5384 auto cb_node = GetCBState(commandBuffer);
5385 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005386 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005387 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005388 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005389 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005390}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005391
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005392bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005393 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005394 bool skip = false;
5395 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5396
Dave Houlton1d960ff2018-01-19 12:17:05 -07005397 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005398 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5399 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5400 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005401 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5402 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005403 }
5404
John Zulaufa26d3c82019-08-14 16:09:08 -06005405 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005406 if (!image_entry) {
5407 return skip;
5408 }
5409
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005410 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5411 if (device_extensions.vk_ext_image_drm_format_modifier) {
5412 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5413 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005414 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5415 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5416 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005417 }
5418 } else {
5419 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005420 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5421 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005422 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005423 }
5424
Dave Houlton1d960ff2018-01-19 12:17:05 -07005425 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005426 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005427 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5428 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5429 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005430 }
5431
Dave Houlton1d960ff2018-01-19 12:17:05 -07005432 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005433 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005434 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5435 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5436 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005437 }
5438
Dave Houlton1d960ff2018-01-19 12:17:05 -07005439 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005440 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005441 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5442 if (FormatIsMultiplane(img_format)) {
5443 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5444 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5445 if (FormatPlaneCount(img_format) > 2u) {
5446 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5447 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5448 }
5449 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005450 skip |= LogError(image, vuid,
5451 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5452 ") must be a single-plane specifier flag.",
5453 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005454 }
5455 } else if (FormatIsColor(img_format)) {
5456 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005457 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5458 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5459 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005460 }
5461 } else if (FormatIsDepthOrStencil(img_format)) {
5462 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5463 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005464 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005465 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5466 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5467 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5468 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005469 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5470 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5471 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005472 }
5473 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005474
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005475 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005476 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005477 }
5478
Mike Weiblen672b58b2017-02-21 14:32:53 -07005479 return skip;
5480}