blob: dbcbacad607fca402fc75d258e46400685b12090 [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),
sfricke-samsung71bc6572020-04-29 15:49:43 -070086 disjoint(false),
87 plane0_memory_requirements_checked(false),
88 plane1_memory_requirements_checked(false),
89 plane2_memory_requirements_checked(false),
unknown08c57af2019-06-21 16:33:35 -060090 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060091 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
92 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
93 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
94 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
95 }
96 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
97 }
98
99 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
100 sparse = true;
101 }
Locked8af3732019-05-10 09:47:56 -0600102
sfricke-samsunge2441192019-11-06 14:07:57 -0800103 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
104 if (externalMemoryInfo) {
105 external_memory_handle = externalMemoryInfo->handleTypes;
106 }
John Zulauff660ad62019-03-23 07:16:05 -0600107}
108
unknown2c877272019-07-11 12:56:50 -0600109bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
110 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
111 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
112 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
113 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
114 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
115 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
116 return is_equal && IsQueueFamilyIndicesEqual(other_createInfo);
117}
118
Jeff Bolz82f854d2019-09-17 14:56:47 -0500119// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
120bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
121 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
122 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
123 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
124 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
125 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
126 is_compatible = is_compatible && IsQueueFamilyIndicesEqual(other_createInfo) && IsTilingEqual(other_createInfo);
127
128 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
129 createInfo.extent.height <= other_createInfo.extent.height &&
130 createInfo.extent.depth <= other_createInfo.extent.depth &&
131 createInfo.arrayLayers <= other_createInfo.arrayLayers;
132 return is_compatible;
133}
134
unknown2c877272019-07-11 12:56:50 -0600135bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700136 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
137 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
138 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700139 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
140 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600141 IsCreateInfoEqual(other_image_state->createInfo)) {
142 return true;
143 }
unknowne1661522019-07-11 13:04:18 -0600144 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
145 return true;
146 }
unknown2c877272019-07-11 12:56:50 -0600147 return false;
148}
149
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500150IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
151 : image_view(iv),
152 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700153 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
154 range_generator(im->range_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500155 samplerConversion(VK_NULL_HANDLE),
156 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600157 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
158 if (conversionInfo) samplerConversion = conversionInfo->conversion;
159 if (image_state) {
160 // A light normalization of the createInfo range
161 auto &sub_res_range = create_info.subresourceRange;
162 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
163 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
164
165 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700166 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500167 samples = image_state->createInfo.samples;
168 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600169 }
170}
171
Dave Houltond9611312018-11-19 17:03:36 -0700172uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
173 // uint cast applies floor()
174 return 1u + (uint32_t)log2(std::max({height, width, depth}));
175}
176
177uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
178
179uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
180
John Zulaufb58415b2019-12-09 15:02:32 -0700181static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
182 const VkImageSubresourceRange &range) {
John Zulauff660ad62019-03-23 07:16:05 -0600183 VkImageSubresourceRange norm = range;
184 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
185
186 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
187 // <arrayLayers> can potentially alias.
188 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
189 ? image_create_info.extent.depth
190 : image_create_info.arrayLayers;
191 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
192
193 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
194 VkImageAspectFlags &aspect_mask = norm.aspectMask;
195 if (FormatIsMultiplane(image_create_info.format)) {
196 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
197 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
198 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
199 if (FormatPlaneCount(image_create_info.format) > 2) {
200 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
201 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700202 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700203 }
John Zulauff660ad62019-03-23 07:16:05 -0600204 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700205}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700206
John Zulaufb58415b2019-12-09 15:02:32 -0700207VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
208 const VkImageCreateInfo &image_create_info = image_state.createInfo;
209 return NormalizeSubresourceRange(image_create_info, range);
210}
211
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500212bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700213 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700214 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700215
John Zulauf2076e812020-01-08 14:55:54 -0700216 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
217 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700218 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
219 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
220
John Zulauf2076e812020-01-08 14:55:54 -0700221 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
222
223 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
224 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700225 return false;
226 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700227
John Zulauf2076e812020-01-08 14:55:54 -0700228 for (auto entry : *layout_range_map) {
229 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700230 }
231 return true;
232}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700233
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600234// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600235void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600236 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
237 VkImageLayout expected_layout) {
238 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
239 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600240 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600241 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700242 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700243 for (const auto &image : image_state.aliasing_images) {
244 auto alias_state = GetImageState(image);
245 // The map state of the aliases should all be in sync, so no need to check the return value
246 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
247 assert(subresource_map);
248 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
249 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700250}
John Zulauff660ad62019-03-23 07:16:05 -0600251
252// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600253void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500254 if (disabled.image_layout_validation) {
255 return;
256 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500257 IMAGE_STATE *image_state = view_state.image_state.get();
258 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700259 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700260 for (const auto &image : image_state->aliasing_images) {
261 image_state = GetImageState(image);
262 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
263 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
264 }
John Zulauff660ad62019-03-23 07:16:05 -0600265}
266
267// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600268void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600269 const VkImageSubresourceRange &range, VkImageLayout layout) {
270 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
271 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600272 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700273 for (const auto &image : image_state.aliasing_images) {
274 auto alias_state = GetImageState(image);
275 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
276 assert(subresource_map);
277 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
278 }
John Zulauff660ad62019-03-23 07:16:05 -0600279}
280
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600281void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600282 VkImageLayout layout) {
283 const IMAGE_STATE *image_state = GetImageState(image);
284 if (!image_state) return;
285 SetImageInitialLayout(cb_node, *image_state, range, layout);
286};
287
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600288void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600289 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
290 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600291}
Dave Houltonddd65c52018-05-08 14:58:01 -0600292
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600293// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700294void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
295 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500296 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600297
John Zulauff660ad62019-03-23 07:16:05 -0600298 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600299 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
300 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600301 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 -0600302 sub_range.baseArrayLayer = 0;
303 sub_range.layerCount = image_state->createInfo.extent.depth;
304 }
305
Piers Daniell4fde9b72019-11-27 16:19:46 -0700306 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
307 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
308 SetImageLayout(cb_node, *image_state, sub_range, layout);
309 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
310 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
311 } else {
312 SetImageLayout(cb_node, *image_state, sub_range, layout);
313 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600314}
315
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700316bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
317 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700318 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600319 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100320 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700321 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100322 const char *vuid;
323 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
324
325 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600326 LogObjectList objlist(image);
327 objlist.add(renderpass);
328 objlist.add(framebuffer);
329 objlist.add(image_view);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700330 skip |= LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
331 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
332 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
333 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100334 return skip;
335 }
336
337 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200338 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
339 if (stencil_usage_info) {
340 image_usage |= stencil_usage_info->stencilUsage;
341 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100342
343 // Check for layouts that mismatch image usages in the framebuffer
344 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800345 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600346 LogObjectList objlist(image);
347 objlist.add(renderpass);
348 objlist.add(framebuffer);
349 objlist.add(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100350 skip |=
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600351 LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700352 "Layout/usage mismatch for attachment %u in %s"
353 " - the %s is %s but the image attached to %s via %s"
354 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
355 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
356 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100357 }
358
359 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
360 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800361 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600362 LogObjectList objlist(image);
363 objlist.add(renderpass);
364 objlist.add(framebuffer);
365 objlist.add(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100366 skip |=
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600367 LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700368 "Layout/usage mismatch for attachment %u in %s"
369 " - the %s is %s but the image attached to %s via %s"
370 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
371 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
372 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100373 }
374
375 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800376 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600377 LogObjectList objlist(image);
378 objlist.add(renderpass);
379 objlist.add(framebuffer);
380 objlist.add(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100381 skip |=
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600382 LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700383 "Layout/usage mismatch for attachment %u in %s"
384 " - the %s is %s but the image attached to %s via %s"
385 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
386 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
387 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100388 }
389
390 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800391 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600392 LogObjectList objlist(image);
393 objlist.add(renderpass);
394 objlist.add(framebuffer);
395 objlist.add(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100396 skip |=
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600397 LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700398 "Layout/usage mismatch for attachment %u in %s"
399 " - the %s is %s but the image attached to %s via %s"
400 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
401 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
402 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100403 }
404
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600405 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100406 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
407 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
408 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
409 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
410 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800411 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600412 LogObjectList objlist(image);
413 objlist.add(renderpass);
414 objlist.add(framebuffer);
415 objlist.add(image_view);
416 skip |= LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700417 "Layout/usage mismatch for attachment %u in %s"
418 " - the %s is %s but the image attached to %s via %s"
419 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
420 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
421 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
422 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100423 }
424 } else {
425 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
426 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
427 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
428 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600429 LogObjectList objlist(image);
430 objlist.add(renderpass);
431 objlist.add(framebuffer);
432 objlist.add(image_view);
433 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700434 "Layout/usage mismatch for attachment %u in %s"
435 " - the %s is %s but the image attached to %s via %s"
436 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
437 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
438 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
439 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100440 }
441 }
442 return skip;
443}
444
John Zulauf17a01bb2019-08-09 16:41:19 -0600445bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700446 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600447 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600448 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700449 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700450 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100451 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100452
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700453 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100454 auto framebuffer = framebuffer_state->framebuffer;
455
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700456 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700457 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
458 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700459 }
John Zulauf8e308292018-09-21 11:34:37 -0600460
Tobias Hectorc9057422019-07-23 12:15:52 +0100461 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
462 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
463 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100464 }
465
Tobias Hectorc9057422019-07-23 12:15:52 +0100466 if (attachments != nullptr) {
467 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
468 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
469 auto image_view = attachments[i];
470 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100471
Tobias Hectorc9057422019-07-23 12:15:52 +0100472 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600473 LogObjectList objlist(pRenderPassBegin->renderPass);
474 objlist.add(framebuffer_state->framebuffer);
475 objlist.add(image_view);
476 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700477 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
478 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
479 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100480 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100481 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100482
483 const VkImage image = view_state->create_info.image;
484 const IMAGE_STATE *image_state = GetImageState(image);
485
486 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600487 LogObjectList objlist(pRenderPassBegin->renderPass);
488 objlist.add(framebuffer_state->framebuffer);
489 objlist.add(image_view);
490 objlist.add(image);
491 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700492 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
493 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
494 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100495 continue;
496 }
497 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
498 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
499
Piers Daniell7f894f62020-01-09 16:33:48 -0700500 // Default to expecting stencil in the same layout.
501 auto attachment_stencil_initial_layout = attachment_initial_layout;
502
503 // If a separate layout is specified, look for that.
504 const auto *attachment_description_stencil_layout =
505 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
506 if (attachment_description_stencil_layout) {
507 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
508 }
509
Tobias Hectorc9057422019-07-23 12:15:52 +0100510 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
511 // in common with the non-const version.)
512 const ImageSubresourceLayoutMap *subresource_map =
513 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
514
515 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
516 LayoutUseCheckAndMessage layout_check(subresource_map);
517 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700518 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
519 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
520 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700521
John Zulauf5e617452019-11-19 14:44:16 -0700522 // Allow for differing depth and stencil layouts
523 VkImageLayout check_layout = attachment_initial_layout;
524 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
525
526 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700527 subres_skip |= LogError(
528 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700529 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
530 "and the %s layout of the attachment is %s. The layouts must match, or the render "
531 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700532 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100533 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700534 }
John Zulauf5e617452019-11-19 14:44:16 -0700535
Tobias Hectorc9057422019-07-23 12:15:52 +0100536 skip |= subres_skip;
537 }
538
539 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
540 framebuffer, render_pass, i, "initial layout");
541
542 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
543 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100544 }
545
Tobias Hectorc9057422019-07-23 12:15:52 +0100546 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
547 auto &subpass = pRenderPassInfo->pSubpasses[j];
548 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
549 auto &attachment_ref = subpass.pInputAttachments[k];
550 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
551 auto image_view = attachments[attachment_ref.attachment];
552 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100553
Tobias Hectorc9057422019-07-23 12:15:52 +0100554 if (view_state) {
555 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700556 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
557 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100558 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100559 }
560 }
561 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100562
Tobias Hectorc9057422019-07-23 12:15:52 +0100563 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
564 auto &attachment_ref = subpass.pColorAttachments[k];
565 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
566 auto image_view = attachments[attachment_ref.attachment];
567 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100568
Tobias Hectorc9057422019-07-23 12:15:52 +0100569 if (view_state) {
570 auto image = view_state->create_info.image;
571 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
572 framebuffer, render_pass, attachment_ref.attachment,
573 "color attachment layout");
574 if (subpass.pResolveAttachments) {
575 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
576 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
577 attachment_ref.attachment, "resolve attachment layout");
578 }
579 }
580 }
581 }
582
583 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
584 auto &attachment_ref = *subpass.pDepthStencilAttachment;
585 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
586 auto image_view = attachments[attachment_ref.attachment];
587 auto view_state = GetImageViewState(image_view);
588
589 if (view_state) {
590 auto image = view_state->create_info.image;
591 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
592 framebuffer, render_pass, attachment_ref.attachment,
593 "input attachment layout");
594 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100595 }
596 }
597 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700598 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600599 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700600}
601
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600602void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700603 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700604 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700605 IMAGE_VIEW_STATE *image_view = nullptr;
606 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
607 const auto attachment_info =
608 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
609 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
610 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300611 image_view = GetAttachmentImageViewState(pCB, pFramebuffer, ref.attachment);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700612 }
John Zulauf8e308292018-09-21 11:34:37 -0600613 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700614 VkImageLayout stencil_layout = kInvalidLayout;
615 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
616 if (attachment_reference_stencil_layout) {
617 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
618 }
619
620 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600621 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700622 }
623}
624
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600625void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
626 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700627 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700628
629 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700630 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700631 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700632 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700633 }
634 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700635 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700636 }
637 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700638 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700639 }
640 }
641}
642
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700643// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
644// 1. Transition into initialLayout state
645// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600646void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700647 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700648 // First transition into initialLayout
649 auto const rpci = render_pass_state->createInfo.ptr();
650 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700651 IMAGE_VIEW_STATE *view_state = nullptr;
652 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
653 const auto attachment_info =
654 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
655 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
656 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300657 view_state = GetAttachmentImageViewState(cb_state, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700658 }
John Zulauf8e308292018-09-21 11:34:37 -0600659 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700660 VkImageLayout stencil_layout = kInvalidLayout;
661 const auto *attachment_description_stencil_layout =
662 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
663 if (attachment_description_stencil_layout) {
664 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
665 }
666
667 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600668 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700669 }
670 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700671 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700672}
673
Dave Houlton10b39482017-03-16 13:18:15 -0600674bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600675 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600676 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600677 }
678 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600679 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600680 }
681 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600682 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600683 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700684 if (0 !=
685 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
686 if (FormatPlaneCount(format) == 1) return false;
687 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600688 return true;
689}
690
Mike Weiblen62d08a32017-03-07 22:18:27 -0700691// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200692bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
693 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600694 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700695 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200696 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600697 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700698
699 switch (layout) {
700 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
701 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600702 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700703 }
704 break;
705 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
706 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600707 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700708 }
709 break;
710 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
711 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600712 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700713 }
714 break;
715 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
716 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600717 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700718 }
719 break;
720 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
721 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600722 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700723 }
724 break;
725 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
726 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600727 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700728 }
729 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600730 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500731 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
732 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
733 }
734 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700735 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
736 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
737 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
738 }
739 break;
740 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
741 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
742 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
743 }
744 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700745 default:
746 // Other VkImageLayout values do not have VUs defined in this context.
747 break;
748 }
749
Dave Houlton8e9f6542018-05-18 12:18:22 -0600750 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700751 skip |= LogError(img_barrier.image, msg_code,
752 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
753 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
754 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700755 }
756 return skip;
757}
758
759// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600760bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
761 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700762 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700763
Petr Krausad0096a2019-08-09 18:35:04 +0200764 // Scoreboard for checking for duplicate and inconsistent barriers to images
765 struct ImageBarrierScoreboardEntry {
766 uint32_t index;
767 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
768 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
769 const VkImageMemoryBarrier *barrier;
770 };
771 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
772 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
773
John Zulauf463c51e2018-05-31 13:29:20 -0600774 // Scoreboard for duplicate layout transition barriers within the list
775 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
776 ImageBarrierScoreboardImageMap layout_transitions;
777
Mike Weiblen62d08a32017-03-07 22:18:27 -0700778 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200779 const auto &img_barrier = pImageMemoryBarriers[i];
780 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700781
John Zulauf463c51e2018-05-31 13:29:20 -0600782 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
783 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
784 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200785 if (img_barrier.oldLayout != img_barrier.newLayout) {
786 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
787 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600788 if (image_it != layout_transitions.end()) {
789 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200790 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600791 if (subres_it != subres_map.end()) {
792 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200793 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
794 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
795 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700796 skip = LogError(
797 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200798 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600799 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
800 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200801 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
802 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
803 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600804 }
805 entry = new_entry;
806 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200807 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600808 }
809 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200810 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600811 }
812 }
813
Petr Krausad0096a2019-08-09 18:35:04 +0200814 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600815 if (image_state) {
816 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200817 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
818 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600819
820 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
821 if (image_state->layout_locked) {
822 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700823 skip |= LogError(
824 img_barrier.image, 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600825 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600826 " 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 +0200827 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
828 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600829 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600830
John Zulaufa4472282019-08-22 14:44:34 -0600831 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700832 const VkFormat image_format = image_create_info.format;
833 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600834 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700835 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700836 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600837 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
838 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700839 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
840 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
841 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
842 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700843 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600844 }
845 } else {
846 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
847 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700848 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03320",
849 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
850 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
851 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700852 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600853 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700854 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700855 }
John Zulauff660ad62019-03-23 07:16:05 -0600856
Petr Krausad0096a2019-08-09 18:35:04 +0200857 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
858 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600859 // TODO: Set memory invalid which is in mem_tracker currently
860 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
861 // subresource.
862 } else if (subresource_map) {
863 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600864 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200865 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700866 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
867 const auto &value = *pos;
868 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700869 subres_skip = LogError(
870 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
John Zulauf5e617452019-11-19 14:44:16 -0700871 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
872 "%s layout is %s.",
873 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
874 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
875 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600876 }
John Zulauf5e617452019-11-19 14:44:16 -0700877 }
John Zulauff660ad62019-03-23 07:16:05 -0600878 skip |= subres_skip;
879 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700880
881 // checks color format and (single-plane or non-disjoint)
882 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
883 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700884 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700885 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
886 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
887 ? "VUID-VkImageMemoryBarrier-image-01671"
888 : "VUID-VkImageMemoryBarrier-image-02902";
889 skip |= LogError(img_barrier.image, vuid,
890 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
891 "but its aspectMask is 0x%" PRIx32 ".",
892 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
893 string_VkFormat(image_format), aspect_mask);
894 }
895 }
896
897 VkImageAspectFlags valid_disjoint_mask =
898 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
sfricke-samsung71bc6572020-04-29 15:49:43 -0700899 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700900 ((aspect_mask & valid_disjoint_mask) == 0)) {
901 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
902 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
903 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
904 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
905 string_VkFormat(image_format), aspect_mask);
906 }
907
908 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
909 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
910 "%s: Image barrier %s references %s of format %s has only two planes but included "
911 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
912 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
913 string_VkFormat(image_format), aspect_mask);
914 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700915 }
916 }
917 return skip;
918}
919
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600920bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200921 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700922
Jeff Bolz6835fda2019-10-06 00:15:34 -0500923 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200924 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700925}
926
John Zulauf6b4aae82018-05-09 13:03:36 -0600927template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600928bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
929 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600930 using BarrierRecord = QFOTransferBarrier<Barrier>;
931 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500932 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600933 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
934 const char *barrier_name = BarrierRecord::BarrierName();
935 const char *handle_name = BarrierRecord::HandleName();
936 const char *transfer_type = nullptr;
937 for (uint32_t b = 0; b < barrier_count; b++) {
938 if (!IsTransferOp(&barriers[b])) continue;
939 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700940 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600941 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600942 const auto found = barrier_sets.release.find(barriers[b]);
943 if (found != barrier_sets.release.cend()) {
944 barrier_record = &(*found);
945 transfer_type = "releasing";
946 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600947 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600948 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600949 const auto found = barrier_sets.acquire.find(barriers[b]);
950 if (found != barrier_sets.acquire.cend()) {
951 barrier_record = &(*found);
952 transfer_type = "acquiring";
953 }
954 }
955 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700956 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
957 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
958 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
959 func_name, barrier_name, b, transfer_type, handle_name,
960 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
961 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600962 }
963 }
964 return skip;
965}
966
John Zulaufa4472282019-08-22 14:44:34 -0600967VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
968 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
969}
970
971const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
972 return device_state.GetImageState(barrier.image);
973}
974
975VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
976 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
977}
978
979const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
980 return device_state.GetBufferState(barrier.buffer);
981}
982
983VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
984
John Zulauf6b4aae82018-05-09 13:03:36 -0600985template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600986void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
987 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500988 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600989 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
990 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600991 auto &barrier = barriers[b];
992 if (IsTransferOp(&barrier)) {
993 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
994 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
995 barrier_sets.release.emplace(barrier);
996 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
997 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
998 barrier_sets.acquire.emplace(barrier);
999 }
1000 }
1001
1002 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1003 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1004 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1005 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1006 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1007 auto handle_state = BarrierHandleState(*this, barrier);
1008 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1009 if (!mode_concurrent) {
1010 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001011 cb_state->queue_submit_functions.emplace_back(
1012 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1013 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1014 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1015 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001016 });
1017 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001018 }
1019 }
1020}
1021
John Zulaufa4472282019-08-22 14:44:34 -06001022bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001023 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001024 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001025 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001026 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001027 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1028 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001029 return skip;
1030}
1031
John Zulaufa4472282019-08-22 14:44:34 -06001032void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1033 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1034 const VkImageMemoryBarrier *pImageMemBarriers) {
1035 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1036 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001037}
1038
1039template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001040bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001041 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001042 // Record to the scoreboard or report that we have a duplication
1043 bool skip = false;
1044 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1045 if (!inserted.second && inserted.first->second != cb_state) {
1046 // 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 -06001047 LogObjectList objlist(cb_state->commandBuffer);
1048 objlist.add(barrier.handle);
1049 objlist.add(inserted.first->second->commandBuffer);
1050 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001051 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1052 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1053 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1054 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1055 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001056 }
1057 return skip;
1058}
1059
1060template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001061bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1062 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001063 using BarrierRecord = QFOTransferBarrier<Barrier>;
1064 using TypeTag = typename BarrierRecord::Tag;
1065 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001066 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001067 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001068 const char *barrier_name = BarrierRecord::BarrierName();
1069 const char *handle_name = BarrierRecord::HandleName();
1070 // No release should have an extant duplicate (WARNING)
1071 for (const auto &release : cb_barriers.release) {
1072 // Check the global pending release barriers
1073 const auto set_it = global_release_barriers.find(release.handle);
1074 if (set_it != global_release_barriers.cend()) {
1075 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1076 const auto found = set_for_handle.find(release);
1077 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001078 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1079 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1080 " to dstQueueFamilyIndex %" PRIu32
1081 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1082 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1083 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001084 }
1085 }
1086 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1087 }
1088 // Each acquire must have a matching release (ERROR)
1089 for (const auto &acquire : cb_barriers.acquire) {
1090 const auto set_it = global_release_barriers.find(acquire.handle);
1091 bool matching_release_found = false;
1092 if (set_it != global_release_barriers.cend()) {
1093 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1094 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1095 }
1096 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001097 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1098 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1099 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1100 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1101 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001102 }
1103 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1104 }
1105 return skip;
1106}
1107
John Zulauf3b04ebd2019-07-18 14:08:11 -06001108bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001109 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001110 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001111 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001112 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1113 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001114 return skip;
1115}
1116
1117template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001118void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001119 using BarrierRecord = QFOTransferBarrier<Barrier>;
1120 using TypeTag = typename BarrierRecord::Tag;
1121 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001122 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001123
1124 // Add release barriers from this submit to the global map
1125 for (const auto &release : cb_barriers.release) {
1126 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1127 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1128 global_release_barriers[release.handle].insert(release);
1129 }
1130
1131 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1132 for (const auto &acquire : cb_barriers.acquire) {
1133 // NOTE: We're not using [] because we don't want to create entries for missing releases
1134 auto set_it = global_release_barriers.find(acquire.handle);
1135 if (set_it != global_release_barriers.end()) {
1136 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1137 set_for_handle.erase(acquire);
1138 if (set_for_handle.size() == 0) { // Clean up empty sets
1139 global_release_barriers.erase(set_it);
1140 }
1141 }
1142 }
1143}
1144
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001145void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001146 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1147 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001148}
1149
John Zulauf6b4aae82018-05-09 13:03:36 -06001150// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001151void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001152
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001153void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001154 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001155 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001156 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001157
Chris Forbes4de4b132017-08-21 11:27:08 -07001158 // For ownership transfers, the barrier is specified twice; as a release
1159 // operation on the yielding queue family, and as an acquire operation
1160 // on the acquiring queue family. This barrier may also include a layout
1161 // transition, which occurs 'between' the two operations. For validation
1162 // purposes it doesn't seem important which side performs the layout
1163 // transition, but it must not be performed twice. We'll arbitrarily
1164 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001165 //
1166 // However, we still need to record initial layout for the "initial layout" validation
1167 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001168
Petr Krausad0096a2019-08-09 18:35:04 +02001169 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001170 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001171 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001172 }
1173}
1174
unknown86bcb3a2019-07-11 13:05:36 -06001175void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001176 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001177 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1178 const auto &image_create_info = image_state->createInfo;
1179
1180 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1181 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1182 // for all (potential) layer sub_resources.
1183 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1184 normalized_isr.baseArrayLayer = 0;
1185 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1186 }
1187
Michael Spang8af7c102020-05-03 20:50:09 -04001188 VkImageLayout initial_layout = mem_barrier.oldLayout;
1189
1190 // Layout transitions in external instance are not tracked, so don't validate initial layout.
1191 if (QueueFamilyIsSpecial(mem_barrier.srcQueueFamilyIndex)) {
1192 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1193 }
1194
John Zulauf2be3fe02019-12-30 09:48:02 -07001195 if (is_release_op) {
1196 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1197 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001198 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001199 }
unknown86bcb3a2019-07-11 13:05:36 -06001200}
1201
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001202bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1203 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1204 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1205 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001206 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001207 assert(cb_node);
1208 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001209 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001210 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001211
John Zulauff660ad62019-03-23 07:16:05 -06001212 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1213 if (subresource_map) {
1214 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001215 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001216 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1217 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001218 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001219 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1220 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1221 "%s layout %s.",
1222 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1223 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1224 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001225 }
John Zulauf5e617452019-11-19 14:44:16 -07001226 }
John Zulauff660ad62019-03-23 07:16:05 -06001227 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001228 }
John Zulauff660ad62019-03-23 07:16:05 -06001229
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001230 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1231 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1232 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001233 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1234 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001235 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1236 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1237 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001238 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001239 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001240 if (image_state->shared_presentable) {
1241 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001242 skip |= LogError(device, layout_invalid_msg_code,
1243 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1244 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001245 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001246 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001247 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001248 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001249 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1250 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1251 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1252 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001253 }
1254 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001255 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001256}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001257bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001258 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1259 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001260 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001261 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1262 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1263}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001264
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001265void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001266 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001267 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001268 if (!renderPass) return;
1269
Tobias Hectorbbb12282018-10-22 15:17:59 +01001270 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001271 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001272 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001273 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001274 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1275 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1276 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1277 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001278 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001279 }
John Zulauf8e308292018-09-21 11:34:37 -06001280 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001281 VkImageLayout stencil_layout = kInvalidLayout;
1282 const auto *attachment_description_stencil_layout =
1283 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1284 if (attachment_description_stencil_layout) {
1285 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1286 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001287 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001288 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001289 }
1290 }
1291}
Dave Houltone19e20d2018-02-02 16:32:41 -07001292
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001293#ifdef VK_USE_PLATFORM_ANDROID_KHR
1294// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1295// This could also move into a seperate core_validation_android.cpp file... ?
1296
1297//
1298// AHB-specific validation within non-AHB APIs
1299//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001300bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001301 bool skip = false;
1302
1303 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1304 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001305 if (0 != ext_fmt_android->externalFormat) {
1306 if (VK_FORMAT_UNDEFINED != create_info->format) {
1307 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001308 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1309 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1310 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001311 }
1312
1313 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001314 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1315 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1316 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001317 }
1318
1319 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001320 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1321 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001322 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1323 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1324 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001325 }
1326
1327 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001328 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1329 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1330 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001331 }
1332 }
1333
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001334 if ((0 != ext_fmt_android->externalFormat) &&
1335 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001336 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001337 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1338 ") which has "
1339 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1340 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001341 }
1342 }
1343
Dave Houltond9611312018-11-19 17:03:36 -07001344 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001345 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001346 skip |=
1347 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1348 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1349 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001350 }
1351 }
1352
1353 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1354 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1355 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001356 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001357 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1358 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1359 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1360 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001361 }
1362
1363 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001364 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1365 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1366 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1367 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1368 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001369 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001370 }
1371
1372 return skip;
1373}
1374
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001375bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001376 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001377 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001378
1379 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001380 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001381 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1382 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001383 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001384 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001385 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001386
Dave Houltond9611312018-11-19 17:03:36 -07001387 // Chain must include a compatible ycbcr conversion
1388 bool conv_found = false;
1389 uint64_t external_format = 0;
1390 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1391 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001392 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001393 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001394 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001395 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001396 }
Dave Houltond9611312018-11-19 17:03:36 -07001397 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001398 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001399 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001400 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1401 "an externalFormat (%" PRIu64
1402 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1403 "with the same external format.",
1404 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001405 }
1406
1407 // Errors in create_info swizzles
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001408 if (((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1409 (create_info->components.r != VK_COMPONENT_SWIZZLE_R)) ||
1410 ((create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1411 (create_info->components.g != VK_COMPONENT_SWIZZLE_G)) ||
1412 ((create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1413 (create_info->components.b != VK_COMPONENT_SWIZZLE_B)) ||
1414 ((create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1415 (create_info->components.a != VK_COMPONENT_SWIZZLE_A))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001416 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1417 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1418 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001419 }
1420 }
Dave Houltond9611312018-11-19 17:03:36 -07001421
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001422 return skip;
1423}
1424
John Zulaufa26d3c82019-08-14 16:09:08 -06001425bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001426 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001427
John Zulaufa26d3c82019-08-14 16:09:08 -06001428 const IMAGE_STATE *image_state = GetImageState(image);
Spencer Fricke224c9852020-04-06 07:47:29 -07001429 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001430 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1431 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1432 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1433 "bound to memory.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001434 }
1435 return skip;
1436}
1437
1438#else
1439
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001440bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001441 return false;
1442}
1443
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001444bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001445
John Zulaufa26d3c82019-08-14 16:09:08 -06001446bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001447
1448#endif // VK_USE_PLATFORM_ANDROID_KHR
1449
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001450bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1451 bool skip = false;
1452
1453 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1454 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1455 const VkImageTiling image_tiling = pCreateInfo->tiling;
1456 const VkFormat image_format = pCreateInfo->format;
1457
1458 if (image_format == VK_FORMAT_UNDEFINED) {
1459 // VU 01975 states format can't be undefined unless an android externalFormat
1460#ifdef VK_USE_PLATFORM_ANDROID_KHR
1461 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1462 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1463 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1464 if (it != ahb_ext_formats_map.end()) {
1465 tiling_features = it->second;
1466 }
1467 }
1468#endif
1469 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1470 uint64_t drm_format_modifier = 0;
1471 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1472 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1473 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1474 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1475
1476 if (drm_explicit != nullptr) {
1477 drm_format_modifier = drm_explicit->drmFormatModifier;
1478 } else {
1479 // VUID 02261 makes sure its only explict or implict in parameter checking
1480 assert(drm_implicit != nullptr);
1481 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1482 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1483 }
1484 }
1485
1486 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1487 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1488 nullptr};
1489 format_properties_2.pNext = (void *)&drm_properties_list;
1490 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
1491
1492 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1493 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1494 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1495 }
1496 }
1497 } else {
1498 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1499 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1500 : format_properties.optimalTilingFeatures;
1501 }
1502
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001503 // Lack of disjoint format feature support while using the flag
1504 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1505 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1506 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1507 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1508 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1509 string_VkFormat(pCreateInfo->format));
1510 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001511
1512 return skip;
1513}
1514
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001515bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001516 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001517 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001518
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001519 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001520 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001521 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1522 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001523 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1524 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001525 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001526 }
1527
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001528 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1529 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001530 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1531 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1532 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001533 }
1534
1535 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001536 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1537 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1538 "height (%d) and arrayLayers (%d) must be >= 6.",
1539 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001540 }
Dave Houlton130c0212018-01-29 13:39:56 -07001541 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001542
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001543 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001544 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1545 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1546 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001547 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1548 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1549 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001550 }
1551
1552 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001553 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1554 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1555 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001556 }
1557
ByumjinConffx991b6062019-08-14 15:17:53 -07001558 if (device_extensions.vk_ext_fragment_density_map) {
1559 uint32_t ceiling_width =
1560 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1561 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1562 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1563 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001564 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1565 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1566 "ceiling of device "
1567 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1568 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1569 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001570 }
1571
1572 uint32_t ceiling_height =
1573 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1574 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1575 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1576 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001577 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1578 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1579 "ceiling of device "
1580 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1581 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1582 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001583 }
1584 }
1585
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001586 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001587 VkResult result = VK_SUCCESS;
1588 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1589 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1590 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1591 &format_limits);
1592 } else {
1593 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1594 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1595 image_format_info.type = pCreateInfo->imageType;
1596 image_format_info.tiling = pCreateInfo->tiling;
1597 image_format_info.usage = pCreateInfo->usage;
1598 image_format_info.flags = pCreateInfo->flags;
1599 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1600 format_limits = image_format_properties.imageFormatProperties;
1601 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001602
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001603 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001604#ifdef VK_USE_PLATFORM_ANDROID_KHR
1605 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1606#endif // VK_USE_PLATFORM_ANDROID_KHR
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001607 skip |= LogError(device, kVUID_Core_Image_FormatNotSupported,
1608 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
1609 "VkGetPhysicalDeviceImageFormatProperties returned back VK_ERROR_FORMAT_NOT_SUPPORTED.",
1610 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001611 } else {
1612 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1613 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001614 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1615 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1616 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001617 }
Dave Houlton130c0212018-01-29 13:39:56 -07001618
Dave Houltona585d132019-01-18 13:05:42 -07001619 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1620 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1621 (uint64_t)pCreateInfo->samples;
1622 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001623
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001624 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001625 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001626 uint64_t ig_mask = imageGranularity - 1;
1627 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001628
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001629 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001630 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1631 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1632 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1633 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001634 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001635
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001636 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001637 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1638 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1639 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001640 }
1641
1642 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001643 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1644 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1645 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001646 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001647 }
1648
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001649 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001650 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1651 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1652 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1653 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001654 skip |= LogError(device, error_vuid,
1655 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1656 "YCbCr Conversion format, arrayLayers must be 1",
1657 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001658 }
1659
1660 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001661 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1662 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1663 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001664 }
1665
1666 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001667 skip |= LogError(
1668 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001669 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1670 string_VkSampleCountFlagBits(pCreateInfo->samples));
1671 }
1672
1673 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001674 skip |= LogError(
1675 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001676 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1677 string_VkImageType(pCreateInfo->imageType));
1678 }
1679 }
1680
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001681 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001682 skip |=
1683 LogError(device, "VUID-VkImageCreateInfo-flags-01924",
1684 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1685 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001686 }
1687
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001688 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001689 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001690 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1691 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001692 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1693 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1694 "format must be block, ETC or ASTC compressed, but is %s",
1695 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001696 }
1697 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001698 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1699 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1700 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001701 }
1702 }
1703 }
1704
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001705 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001706 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1707 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1708 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001709 }
1710
unknown2c877272019-07-11 12:56:50 -06001711 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1712 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1713 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001714 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1715 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1716 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001717 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001718
1719 skip |= ValidateImageFormatFeatures(pCreateInfo);
1720
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001721 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001722}
1723
John Zulauf7eeb6f72019-06-17 11:56:36 -06001724void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1725 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1726 if (VK_SUCCESS != result) return;
1727
1728 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001729 auto image_state = Get<IMAGE_STATE>(*pImage);
1730 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001731}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001732
Jeff Bolz5c801d12019-10-09 10:38:45 -05001733bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001734 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001735 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001736 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001737 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001738 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001739 }
1740 return skip;
1741}
1742
John Zulauf7eeb6f72019-06-17 11:56:36 -06001743void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1744 // Clean up validation specific data
1745 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001746
locke-lunargcba7d5f2019-12-30 16:59:11 -07001747 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001748
1749 // Clean up generic image state
1750 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001751}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001752
John Zulauf07288512019-07-05 11:09:50 -06001753bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001754 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001755
1756 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1757 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 -07001758 skip |= LogError(image_state->image, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001759 }
1760
Dave Houlton1d2022c2017-03-29 11:43:58 -06001761 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001762 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001763 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001764 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001765 char const str[] = "vkCmdClearColorImage called with compressed image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001766 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001767 }
1768
1769 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1770 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001771 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001772 }
1773 return skip;
1774}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001775
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001776uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1777 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1778 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001779 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001780 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001781 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001782 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001783}
1784
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001785uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1786 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1787 uint32_t array_layer_count = range->layerCount;
1788 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1789 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001790 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001791 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001792}
1793
John Zulauf07288512019-07-05 11:09:50 -06001794bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1795 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1796 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001797 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001798 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1799 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001800 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1801 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1802 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001803 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001804
1805 } else {
1806 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1807 if (!device_extensions.vk_khr_shared_presentable_image) {
1808 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001809 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1810 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1811 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001812 }
1813 } else {
1814 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1815 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001816 skip |= LogError(
1817 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001818 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1819 func_name, string_VkImageLayout(dest_image_layout));
1820 }
1821 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001822 }
1823
John Zulauff660ad62019-03-23 07:16:05 -06001824 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001825 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001826 if (subresource_map) {
1827 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001828 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001829 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001830 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1831 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001832 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1833 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1834 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1835 } else {
1836 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001837 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001838 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1839 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1840 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1841 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001842 }
John Zulauf5e617452019-11-19 14:44:16 -07001843 }
John Zulauff660ad62019-03-23 07:16:05 -06001844 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001845 }
1846
1847 return skip;
1848}
1849
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001850bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1851 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001852 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001853 bool skip = false;
1854 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001855 const auto *cb_node = GetCBState(commandBuffer);
1856 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001857 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001858 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001859 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001860 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001861 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001862 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001863 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1864 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001865 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001866 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001867 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001868 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001869 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001870 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1871 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001872 }
sfricke-samsunge775d492020-02-28 09:02:25 -08001873 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
1874 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
1875 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
1876 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
1877 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
1878 string_VkFormat(image_state->createInfo.format));
1879 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001880 }
1881 return skip;
1882}
1883
John Zulaufeabb4462019-07-05 14:13:03 -06001884void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1885 const VkClearColorValue *pColor, uint32_t rangeCount,
1886 const VkImageSubresourceRange *pRanges) {
1887 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1888
1889 auto cb_node = GetCBState(commandBuffer);
1890 auto image_state = GetImageState(image);
1891 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001892 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001893 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001894 }
1895 }
1896}
1897
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001898bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1899 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001900 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001901 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001902
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001903 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001904 const auto *cb_node = GetCBState(commandBuffer);
1905 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001906 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001907 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001908 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001909 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001910 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001911 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001912 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001913 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001914 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001915 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001916 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001917
1918 bool any_include_aspect_depth_bit = false;
1919 bool any_include_aspect_stencil_bit = false;
1920
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001921 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001922 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001923 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001924 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001925 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001926 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1927 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001928 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001929 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1930 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001931 skip |= LogError(commandBuffer, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001932 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001933 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1934 any_include_aspect_depth_bit = true;
1935 }
1936 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1937 any_include_aspect_stencil_bit = true;
1938 }
1939 }
1940 if (any_include_aspect_stencil_bit) {
1941 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1942 if (image_stencil_struct != nullptr) {
1943 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1944 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001945 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1946 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1947 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1948 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001949 }
1950 } else {
1951 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001952 skip |= LogError(
1953 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05001954 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1955 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1956 "in VkImageCreateInfo::usage used to create image");
1957 }
1958 }
1959 }
1960 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001961 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1962 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1963 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001964 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001965 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001966 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001967 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001968 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001969 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1970 char const str[] =
1971 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1972 "set.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001973 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001974 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001975 }
1976 return skip;
1977}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001978
John Zulaufeabb4462019-07-05 14:13:03 -06001979void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1980 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1981 const VkImageSubresourceRange *pRanges) {
1982 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1983 auto cb_node = GetCBState(commandBuffer);
1984 auto image_state = GetImageState(image);
1985 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001986 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001987 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001988 }
1989 }
1990}
1991
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001992// Returns true if [x, xoffset] and [y, yoffset] overlap
1993static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1994 bool result = false;
1995 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1996 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1997
1998 if (intersection_max > intersection_min) {
1999 result = true;
2000 }
2001 return result;
2002}
2003
Dave Houltonc991cc92018-03-06 11:08:51 -07002004// Returns true if source area of first copy region intersects dest area of second region
2005// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2006static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002007 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002008
Dave Houltonc991cc92018-03-06 11:08:51 -07002009 // Separate planes within a multiplane image cannot intersect
2010 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002011 return result;
2012 }
2013
Dave Houltonc991cc92018-03-06 11:08:51 -07002014 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2015 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2016 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002017 result = true;
2018 switch (type) {
2019 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002020 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002021 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002022 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002023 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002024 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002025 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002026 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002027 break;
2028 default:
2029 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2030 assert(false);
2031 }
2032 }
2033 return result;
2034}
2035
Dave Houltonfc1a4052017-04-27 14:32:45 -06002036// Returns non-zero if offset and extent exceed image extents
2037static const uint32_t x_bit = 1;
2038static const uint32_t y_bit = 2;
2039static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002040static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002041 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002042 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002043 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2044 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002045 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002046 }
2047 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2048 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002049 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002050 }
2051 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2052 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002053 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002054 }
2055 return result;
2056}
2057
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002058// Test if two VkExtent3D structs are equivalent
2059static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2060 bool result = true;
2061 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2062 (extent->depth != other_extent->depth)) {
2063 result = false;
2064 }
2065 return result;
2066}
2067
Dave Houltonee281a52017-12-08 13:51:02 -07002068// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
2069// Destination image texel extents must be adjusted by block size for the dest validation checks
2070VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
2071 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06002072 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2073 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002074 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002075 adjusted_extent.width /= block_size.width;
2076 adjusted_extent.height /= block_size.height;
2077 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06002078 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2079 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002080 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002081 adjusted_extent.width *= block_size.width;
2082 adjusted_extent.height *= block_size.height;
2083 adjusted_extent.depth *= block_size.depth;
2084 }
2085 return adjusted_extent;
2086}
2087
Dave Houlton6f9059e2017-05-02 17:15:13 -06002088// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002089static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2090 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002091
2092 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002093 if (mip >= img->createInfo.mipLevels) {
2094 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002095 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002096
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002097 // 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 -06002098 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002099
Dave Houltone48cd112019-01-03 17:01:18 -07002100 // If multi-plane, adjust per-plane extent
2101 if (FormatIsMultiplane(img->createInfo.format)) {
2102 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2103 extent.width /= divisors.width;
2104 extent.height /= divisors.height;
2105 }
2106
Jeff Bolzef40fec2018-09-01 22:04:34 -05002107 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2108 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002109 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002110 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2111 } else {
2112 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2113 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2114 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2115 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002116
Dave Houlton6f9059e2017-05-02 17:15:13 -06002117 // Image arrays have an effective z extent that isn't diminished by mip level
2118 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002119 extent.depth = img->createInfo.arrayLayers;
2120 }
2121
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002122 return extent;
2123}
2124
2125// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002126static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002127 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2128}
2129
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002130// Test if the extent argument has any dimensions set to 0.
2131static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2132 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2133}
2134
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002135// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002136VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002137 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2138 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002139 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002140 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002141 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002142 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002143 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002144 granularity.width *= block_size.width;
2145 granularity.height *= block_size.height;
2146 }
2147 }
2148 return granularity;
2149}
2150
2151// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2152static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2153 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002154 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2155 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002156 valid = false;
2157 }
2158 return valid;
2159}
2160
2161// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002162bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002163 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002164 bool skip = false;
2165 VkExtent3D offset_extent = {};
2166 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2167 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2168 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002169 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002170 // 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 -07002171 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002172 skip |= LogError(cb_node->commandBuffer, vuid,
2173 "%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 "
2174 "image transfer granularity is (w=0, h=0, d=0).",
2175 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002176 }
2177 } else {
2178 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2179 // integer multiples of the image transfer granularity.
2180 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002181 skip |= LogError(cb_node->commandBuffer, vuid,
2182 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2183 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2184 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2185 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002186 }
2187 }
2188 return skip;
2189}
2190
2191// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002192bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002193 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002194 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002195 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002196 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002197 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2198 // subresource extent.
2199 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002200 skip |= LogError(cb_node->commandBuffer, vuid,
2201 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2202 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2203 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2204 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002205 }
2206 } else {
2207 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2208 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2209 // subresource extent dimensions.
2210 VkExtent3D offset_extent_sum = {};
2211 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2212 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2213 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002214 bool x_ok = true;
2215 bool y_ok = true;
2216 bool z_ok = true;
2217 switch (image_type) {
2218 case VK_IMAGE_TYPE_3D:
2219 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2220 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002221 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002222 case VK_IMAGE_TYPE_2D:
2223 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2224 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002225 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002226 case VK_IMAGE_TYPE_1D:
2227 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2228 (subresource_extent->width == offset_extent_sum.width));
2229 break;
2230 default:
2231 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2232 assert(false);
2233 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002234 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002235 skip |=
2236 LogError(cb_node->commandBuffer, vuid,
2237 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2238 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2239 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2240 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2241 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2242 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002243 }
2244 }
2245 return skip;
2246}
2247
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002248bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002249 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002250 bool skip = false;
2251 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002252 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2253 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002254 }
2255 return skip;
2256}
2257
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002258bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002259 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002260 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002261 bool skip = false;
2262 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2263 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002264 skip |= LogError(cb_node->commandBuffer, vuid,
2265 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2266 "%u, but provided %s has %u array layers.",
2267 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2268 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002269 }
2270 return skip;
2271}
2272
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002273// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002274bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002275 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002276 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002277 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002278 VkExtent3D granularity = GetScaledItg(cb_node, img);
2279 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002280 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002281 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002282 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002283 return skip;
2284}
2285
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002286// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002287bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002288 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002289 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002290 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002291 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002292 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2293 skip |=
2294 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002295 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002296 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002297 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2298 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002299
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002300 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002301 granularity = GetScaledItg(cb_node, dst_img);
2302 skip |=
2303 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002304 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002305 const VkExtent3D dest_effective_extent =
2306 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002307 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002308 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002309 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002310 return skip;
2311}
2312
Dave Houlton6f9059e2017-05-02 17:15:13 -06002313// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002314bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002315 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002316 bool skip = false;
2317
2318 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002319 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002320
2321 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002322 const VkExtent3D src_copy_extent = region.extent;
2323 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002324 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2325
Dave Houlton6f9059e2017-05-02 17:15:13 -06002326 bool slice_override = false;
2327 uint32_t depth_slices = 0;
2328
2329 // Special case for copying between a 1D/2D array and a 3D image
2330 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2331 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002332 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002333 slice_override = (depth_slices != 1);
2334 } 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 -07002335 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002336 slice_override = (depth_slices != 1);
2337 }
2338
2339 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002340 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002341 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002342 skip |=
2343 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2344 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2345 "be 0 and 1, respectively.",
2346 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002347 }
2348 }
2349
Dave Houlton533be9f2018-03-26 17:08:30 -06002350 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 -07002351 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2352 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2353 "these must be 0 and 1, respectively.",
2354 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002355 }
2356
Dave Houlton533be9f2018-03-26 17:08:30 -06002357 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002358 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2359 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2360 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002361 }
2362
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002363 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002364 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002365 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002366 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002367 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2368 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2369 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2370 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002371 }
2372 }
2373 } else { // Pre maint 1
2374 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002375 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002376 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2377 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2378 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2379 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2380 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002381 }
2382 }
2383 }
2384
Dave Houltonc991cc92018-03-06 11:08:51 -07002385 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002386 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002387 if (FormatIsCompressed(src_state->createInfo.format) ||
2388 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002389 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002390 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002391 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2392 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2393 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002394 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002395 skip |= LogError(src_state->image, vuid,
2396 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2397 "texel width & height (%d, %d).",
2398 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002399 }
2400
Dave Houlton94a00372017-12-14 15:08:47 -07002401 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002402 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2403 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002404 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002405 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002406 LogError(src_state->image, vuid,
2407 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2408 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2409 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002410 }
2411
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002412 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002413 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2414 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002415 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002416 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002417 LogError(src_state->image, vuid,
2418 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2419 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2420 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002421 }
2422
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002423 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002424 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2425 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002426 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002427 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002428 LogError(src_state->image, vuid,
2429 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2430 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2431 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002432 }
2433 } // Compressed
2434
2435 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002436 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002437 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002438 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2439 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2440 "these must be 0 and 1, respectively.",
2441 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002442 }
2443 }
2444
Dave Houlton533be9f2018-03-26 17:08:30 -06002445 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 -07002446 skip |=
2447 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2448 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2449 "and 1, respectively.",
2450 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002451 }
2452
Dave Houlton533be9f2018-03-26 17:08:30 -06002453 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002454 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2455 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2456 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002457 }
2458
2459 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002460 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002461 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2462 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2463 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2464 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002465 }
2466 }
2467 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002468 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002469 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002470 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002471 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002472 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2473 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2474 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2475 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002476 }
2477 }
2478 } else { // Pre maint 1
2479 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002480 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002481 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2482 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2483 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2484 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2485 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002486 }
2487 }
2488 }
2489
Dave Houltonc991cc92018-03-06 11:08:51 -07002490 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2491 if (FormatIsCompressed(dst_state->createInfo.format) ||
2492 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002493 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002494
2495 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002496 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2497 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2498 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002499 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002500 skip |= LogError(dst_state->image, vuid,
2501 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2502 "texel width & height (%d, %d).",
2503 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002504 }
2505
Dave Houlton94a00372017-12-14 15:08:47 -07002506 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002507 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2508 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002509 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002510 skip |= LogError(
2511 dst_state->image, vuid,
2512 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2513 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2514 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002515 }
2516
Dave Houltonee281a52017-12-08 13:51:02 -07002517 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2518 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2519 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002520 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002521 skip |= LogError(dst_state->image, vuid,
2522 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2523 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2524 "height (%d).",
2525 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002526 }
2527
Dave Houltonee281a52017-12-08 13:51:02 -07002528 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2529 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2530 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002531 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002532 skip |= LogError(
2533 dst_state->image, vuid,
2534 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2535 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2536 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002537 }
2538 } // Compressed
2539 }
2540 return skip;
2541}
2542
Dave Houltonc991cc92018-03-06 11:08:51 -07002543// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002544bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002545 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002546 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002547
2548 // Neither image is multiplane
2549 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2550 // If neither image is multi-plane the aspectMask member of src and dst must match
2551 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2552 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002553 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002554 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002555 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002556 }
2557 } else {
2558 // Source image multiplane checks
2559 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2560 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2561 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2562 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002563 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002564 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002565 }
2566 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2567 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2568 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002569 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002570 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002571 }
2572 // Single-plane to multi-plane
2573 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2574 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2575 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002576 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002577 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002578 }
2579
2580 // Dest image multiplane checks
2581 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2582 aspect = region.dstSubresource.aspectMask;
2583 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2584 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002585 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002586 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002587 }
2588 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2589 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2590 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002591 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002592 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002593 }
2594 // Multi-plane to single-plane
2595 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2596 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2597 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002598 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002599 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002600 }
2601 }
2602
2603 return skip;
2604}
2605
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002606bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2607 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002608 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002609 const auto *cb_node = GetCBState(commandBuffer);
2610 const auto *src_image_state = GetImageState(srcImage);
2611 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002612 const VkFormat src_format = src_image_state->createInfo.format;
2613 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002614 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002615
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002616 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002617
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002618 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2619
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002620 for (uint32_t i = 0; i < regionCount; i++) {
2621 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002622
2623 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2624 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002625 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002626
Dave Houlton6f9059e2017-05-02 17:15:13 -06002627 bool slice_override = false;
2628 uint32_t depth_slices = 0;
2629
2630 // Special case for copying between a 1D/2D array and a 3D image
2631 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2632 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2633 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002634 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002635 slice_override = (depth_slices != 1);
2636 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2637 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002638 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002639 slice_override = (depth_slices != 1);
2640 }
2641
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002642 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2643 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2644 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002645 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002646 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002647 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002648 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002649 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2650 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002651 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002652 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2653 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002654
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002655 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002656 // No chance of mismatch if we're overriding depth slice count
2657 if (!slice_override) {
2658 // The number of depth slices in srcSubresource and dstSubresource must match
2659 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2660 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002661 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2662 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002663 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002664 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2665 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002666 if (src_slices != dst_slices) {
2667 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002668 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002669 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002670 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002671 }
2672 }
2673 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002674 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002675 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002676 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002677 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002678 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002679 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002680 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002681 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002682
Dave Houltonc991cc92018-03-06 11:08:51 -07002683 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002684 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002685 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002686 }
2687
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002688 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002689 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2690 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002691 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002692 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002693 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002694 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002695
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002696 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002697 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002698 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002699 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002700 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002701 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002702 }
2703
2704 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002705 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002706 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002707 ss << "vkCmdCopyImage(): pRegion[" << i
2708 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002709 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002710 }
2711
Dave Houltonfc1a4052017-04-27 14:32:45 -06002712 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002713 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2714 if (slice_override) src_copy_extent.depth = depth_slices;
2715 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002716 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002717 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002718 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2719 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2720 "width [%1d].",
2721 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002722 }
2723
2724 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002725 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002726 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2727 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2728 "height [%1d].",
2729 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002730 }
2731 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002732 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002733 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2734 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2735 "depth [%1d].",
2736 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002737 }
2738
Dave Houltonee281a52017-12-08 13:51:02 -07002739 // Adjust dest extent if necessary
2740 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2741 if (slice_override) dst_copy_extent.depth = depth_slices;
2742
2743 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002744 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002745 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2746 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2747 "width [%1d].",
2748 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002749 }
2750 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002751 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2752 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2753 "height [%1d].",
2754 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002755 }
2756 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002757 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2758 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2759 "depth [%1d].",
2760 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002761 }
2762
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002763 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2764 // must not overlap in memory
2765 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002766 for (uint32_t j = 0; j < regionCount; j++) {
2767 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002768 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002769 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002770 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002771 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002772 }
2773 }
2774 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002775
2776 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2777 if (device_extensions.vk_khr_maintenance1) {
2778 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2779 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2780 (src_copy_extent.depth != 1)) {
2781 skip |= LogError(
2782 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2783 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2784 src_copy_extent.depth);
2785 }
2786 } else {
2787 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2788 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2789 (src_copy_extent.depth != 1)) {
2790 skip |= LogError(
2791 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2792 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2793 src_copy_extent.depth);
2794 }
2795 }
2796
2797 // Check if 2D with 3D and depth not equal to 2D layerCount
2798 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2799 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2800 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2801 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2802 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2803 "srcSubresource.layerCount (%u)",
2804 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2805 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2806 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2807 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2808 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2809 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2810 "dstSubresource.layerCount (%u)",
2811 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2812 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002813
2814 // Check for multi-plane format compatiblity
2815 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
2816 size_t src_format_size = 0;
2817 size_t dst_format_size = 0;
2818 if (FormatIsMultiplane(src_format)) {
2819 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
2820 src_format_size = FormatElementSize(planeFormat);
2821 } else {
2822 src_format_size = FormatElementSize(src_format);
2823 }
2824 if (FormatIsMultiplane(dst_format)) {
2825 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
2826 dst_format_size = FormatElementSize(planeFormat);
2827 } else {
2828 dst_format_size = FormatElementSize(dst_format);
2829 }
2830 // If size is still zero, then format is invalid and will be caught in another VU
2831 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
2832 skip |=
2833 LogError(command_buffer, "VUID-vkCmdCopyImage-None-01549",
2834 "vkCmdCopyImage(): pRegions[%u] called with non-compatible image formats. "
2835 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
2836 i, string_VkFormat(src_format), string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(),
2837 string_VkFormat(dst_format), string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
2838 }
2839 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002840 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002841
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002842 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
2843 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
2844 // because because both texels are 4 bytes in size.
2845 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
2846 const char *compatible_vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2847 : "VUID-vkCmdCopyImage-srcImage-00135";
2848 // Depth/stencil formats must match exactly.
2849 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2850 if (src_format != dst_format) {
2851 skip |= LogError(command_buffer, compatible_vuid,
2852 "vkCmdCopyImage(): Depth/stencil formats must match exactly for src (%s) and dst (%s).",
2853 string_VkFormat(src_format), string_VkFormat(dst_format));
2854 }
2855 } else {
2856 if (!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) {
2857 skip |= LogError(command_buffer, compatible_vuid,
2858 "vkCmdCopyImage(): Unmatched image format sizes. "
2859 "The src format %s has size of %zu and dst format %s has size of %zu.",
2860 string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
2861 FormatElementSize(dst_format));
2862 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002863 }
2864 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002865
Dave Houlton33c22b72017-02-28 13:16:02 -07002866 // Source and dest image sample counts must match
2867 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2868 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002869 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002870 }
2871
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002872 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2873 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002874 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002875 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2876 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2877 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2878 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002879 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002880 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002881 "VUID-vkCmdCopyImage-srcImage-01995");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002882 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002883 "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002884 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002885 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002886 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002887 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2888 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002889 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002890 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2891 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2892 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2893 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2894 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2895 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002896 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002897 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002898 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2899 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002900 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002901 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2902 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002903 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2904 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002905 }
2906
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002907 return skip;
2908}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002909
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002910void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2911 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2912 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002913 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2914 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002915 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002916 auto src_image_state = GetImageState(srcImage);
2917 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002918
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002919 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002920 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002921 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2922 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002923 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002924}
2925
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002926// Returns true if sub_rect is entirely contained within rect
2927static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2928 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2929 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2930 return false;
2931 return true;
2932}
2933
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002934bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002935 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2936 const VkRect2D &render_area, uint32_t rect_count,
2937 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002938 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002939 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2940 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06002941 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07002942 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002943
2944 for (uint32_t j = 0; j < rect_count; j++) {
2945 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002946 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2947 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2948 "the current render pass instance.",
2949 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002950 }
2951
2952 if (image_view_state) {
2953 // The layers specified by a given element of pRects must be contained within every attachment that
2954 // pAttachments refers to
2955 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2956 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2957 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002958 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2959 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2960 "of pAttachment[%d].",
2961 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002962 }
2963 }
2964 }
2965 return skip;
2966}
2967
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002968bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2969 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002970 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002971 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002972 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002973 if (!cb_node) return skip;
2974
2975 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2976 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2977 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002978 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002979
2980 // Validate that attachment is in reference list of active subpass
2981 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002982 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002983 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002984 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002985 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002986 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002987
John Zulauf3a548ef2019-02-01 16:14:07 -07002988 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2989 auto clear_desc = &pAttachments[attachment_index];
2990 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002991
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002992 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002993 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002994 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002995 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002996 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002997 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2998 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2999 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3000 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003001 skip |= LogError(
3002 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3003 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3004 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3005 attachment_index, clear_desc->colorAttachment,
3006 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3007 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003008
John Zulauff2582972019-02-09 14:53:30 -07003009 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3010 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003011 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003012 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3013 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3014 " subpass %u. colorAttachmentCount=%u",
3015 attachment_index, clear_desc->colorAttachment,
3016 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3017 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003018 }
John Zulauff2582972019-02-09 14:53:30 -07003019 fb_attachment = color_attachment;
3020
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003021 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3022 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3023 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003024 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003025 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003026 }
3027 } else { // Must be depth and/or stencil
3028 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
3029 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003030 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003031 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003032 }
3033 if (!subpass_desc->pDepthStencilAttachment ||
3034 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003035 skip |= LogPerformanceWarning(
3036 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003037 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003038 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003039 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003040 }
3041 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003042 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003043 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3044 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003045 }
3046 }
3047 }
3048 return skip;
3049}
3050
3051void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3052 const VkClearAttachment *pAttachments, uint32_t rectCount,
3053 const VkClearRect *pRects) {
3054 auto *cb_node = GetCBState(commandBuffer);
3055 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3056 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3057 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3058 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3059 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3060 const auto clear_desc = &pAttachments[attachment_index];
3061 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3062 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3063 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3064 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3065 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3066 subpass_desc->pDepthStencilAttachment) {
3067 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3068 }
3069 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003070 if (!clear_rect_copy) {
3071 // We need a copy of the clear rectangles that will persist until the last lambda executes
3072 // but we want to create it as lazily as possible
3073 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003074 }
John Zulauf441558b2019-08-12 11:47:39 -06003075 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3076 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003077 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003078 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003079 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003080 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003081 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3082 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003083 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3084 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003085 return skip;
3086 };
3087 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003088 }
3089 }
3090 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003091}
3092
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003093bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3094 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003095 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003096 const auto *cb_node = GetCBState(commandBuffer);
3097 const auto *src_image_state = GetImageState(srcImage);
3098 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003099
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003100 bool skip = false;
3101 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003102 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3103 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003104 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003105 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003106 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3107 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003108 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003109 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003110
Cort Stratton7df30962018-05-17 19:45:57 -07003111 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003112 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003113 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003114 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3115 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3116 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003117 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003118 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3119 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003120 // For each region, the number of layers in the image subresource should not be zero
3121 // For each region, src and dest image aspect must be color only
3122 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003123 skip |=
3124 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3125 skip |=
3126 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003127 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003128 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3129 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003130 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003131 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3132 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003133 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3134 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3135 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3136 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3137 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003138 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3139 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003140 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003141 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3142 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003143
3144 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003145 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003146 skip |= LogError(
3147 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003148 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003149 }
Cort Stratton7df30962018-05-17 19:45:57 -07003150 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003151 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3152 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3153 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003154 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003155 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003156 }
3157 }
3158
3159 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3160 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003161 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003162 }
3163 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3164 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003165 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003166 }
3167 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3168 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003169 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003170 }
3171 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3172 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003173 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003174 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003175 } else {
3176 assert(0);
3177 }
3178 return skip;
3179}
3180
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003181bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3182 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003183 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003184 const auto *cb_node = GetCBState(commandBuffer);
3185 const auto *src_image_state = GetImageState(srcImage);
3186 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003187
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003188 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003189 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003190 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003191 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003192 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003193 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003194 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003195 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003196 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003197 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3198 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003199 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003200 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3201 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003202 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003203 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3204 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003205 skip |=
3206 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003207 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3208 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003209 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003210 "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003211 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003212 "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003213
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003214 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003215
Dave Houlton33c2d252017-06-09 17:08:32 -06003216 VkFormat src_format = src_image_state->createInfo.format;
3217 VkFormat dst_format = dst_image_state->createInfo.format;
3218 VkImageType src_type = src_image_state->createInfo.imageType;
3219 VkImageType dst_type = dst_image_state->createInfo.imageType;
3220
Cort Stratton186b1a22018-05-01 20:18:06 -04003221 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003222 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003223 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003224 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003225 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003226 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003227 }
3228
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003229 if (FormatRequiresYcbcrConversion(src_format)) {
3230 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3231 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3232 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3233 string_VkFormat(src_format));
3234 }
3235
3236 if (FormatRequiresYcbcrConversion(dst_format)) {
3237 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3238 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3239 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3240 string_VkFormat(dst_format));
3241 }
3242
Dave Houlton33c2d252017-06-09 17:08:32 -06003243 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003244 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3245 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003246 }
3247
Dave Houlton33c2d252017-06-09 17:08:32 -06003248 // Validate consistency for unsigned formats
3249 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3250 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003251 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003252 << "the other one must also have unsigned integer format. "
3253 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003254 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003255 }
3256
3257 // Validate consistency for signed formats
3258 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3259 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003260 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003261 << "the other one must also have signed integer format. "
3262 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003263 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003264 }
3265
3266 // Validate filter for Depth/Stencil formats
3267 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3268 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003269 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003270 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003271 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003272 }
3273
3274 // Validate aspect bits and formats for depth/stencil images
3275 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3276 if (src_format != dst_format) {
3277 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003278 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003279 << "stencil, the other one must have exactly the same format. "
3280 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3281 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003282 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003283 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003284 } // Depth or Stencil
3285
3286 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003287 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003288 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003289 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3290 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3291 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003292 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003293 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3294 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003295 for (uint32_t i = 0; i < regionCount; i++) {
3296 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003297 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003298 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003299 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3300 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003301 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003302 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3303 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003304 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3305 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3306 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003307 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003308 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003309 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003310 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003311 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3312 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003313 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003314 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3315 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003316 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003317 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3318 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003319 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003320 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003321 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003322 }
Dave Houlton48989f32017-05-26 15:01:46 -06003323 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3324 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003325 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003326 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003327 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003328 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003329
3330 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003331 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003332 skip |= LogError(
3333 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003334 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003335 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003336
Dave Houlton48989f32017-05-26 15:01:46 -06003337 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003338 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3339 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003340 }
Dave Houlton48989f32017-05-26 15:01:46 -06003341
Dave Houlton33c2d252017-06-09 17:08:32 -06003342 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003343 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3344 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3345 "image format %s.",
3346 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003347 }
3348
3349 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003350 skip |= LogError(
3351 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003352 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3353 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003354 }
3355
Dave Houlton48989f32017-05-26 15:01:46 -06003356 // Validate source image offsets
3357 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003358 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003359 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003360 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003361 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3362 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3363 "of (%1d, %1d). These must be (0, 1).",
3364 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003365 }
3366 }
3367
Dave Houlton33c2d252017-06-09 17:08:32 -06003368 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003369 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003370 skip |=
3371 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3372 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3373 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3374 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003375 }
3376 }
3377
Dave Houlton33c2d252017-06-09 17:08:32 -06003378 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003379 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3380 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003381 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003382 skip |= LogError(
3383 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003384 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3385 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003386 }
3387 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3388 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003389 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003390 skip |= LogError(
3391 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003392 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003393 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003394 }
3395 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3396 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003397 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003398 skip |= LogError(
3399 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003400 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3401 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003402 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003403 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003404 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3405 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003406 }
Dave Houlton48989f32017-05-26 15:01:46 -06003407
3408 // Validate dest image offsets
3409 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003410 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003411 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003412 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003413 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3414 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3415 "(%1d, %1d). These must be (0, 1).",
3416 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003417 }
3418 }
3419
Dave Houlton33c2d252017-06-09 17:08:32 -06003420 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003421 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003422 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3423 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3424 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3425 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003426 }
3427 }
3428
Dave Houlton33c2d252017-06-09 17:08:32 -06003429 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003430 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3431 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003432 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003433 skip |= LogError(
3434 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003435 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3436 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003437 }
3438 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3439 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003440 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003441 skip |= LogError(
3442 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003443 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003444 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003445 }
3446 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3447 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003448 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003449 skip |= LogError(
3450 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003451 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3452 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003453 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003454 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003455 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3456 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003457 }
3458
Dave Houlton33c2d252017-06-09 17:08:32 -06003459 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3460 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3461 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003462 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003463 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3464 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3465 "layerCount other than 1.",
3466 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003467 }
3468 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003469 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003470 } else {
3471 assert(0);
3472 }
3473 return skip;
3474}
3475
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003476void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3477 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3478 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003479 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3480 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003481 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003482 auto src_image_state = GetImageState(srcImage);
3483 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003484
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003485 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003486 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003487 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3488 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003489 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003490}
3491
John Zulauf2076e812020-01-08 14:55:54 -07003492GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3493 assert(map);
3494 // This approach allows for a single hash lookup or/create new
3495 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3496 if (inserted.second) {
3497 assert(nullptr == inserted.first->second.get());
3498 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.range_encoder.SubresourceCount());
3499 inserted.first->second.reset(layout_map);
3500 return layout_map;
3501 } else {
3502 assert(nullptr != inserted.first->second.get());
3503 return inserted.first->second.get();
3504 }
3505 return nullptr;
3506}
3507
3508const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3509 auto it = map.find(image);
3510 if (it != map.end()) {
3511 return it->second.get();
3512 }
3513 return nullptr;
3514}
3515
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003516// 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 -07003517bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3518 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003519 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003520 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003521 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003522 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003523 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003524 for (const auto &layout_map_entry : pCB->image_layout_map) {
3525 const auto image = layout_map_entry.first;
3526 const auto *image_state = GetImageState(image);
3527 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003528 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003529 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003530 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003531 if (initial_layout_map.empty()) continue;
3532
3533 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3534 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3535 if (global_map == nullptr) {
3536 global_map = &empty_map;
3537 }
3538
3539 // Note: don't know if it would matter
3540 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3541
3542 auto pos = initial_layout_map.begin();
3543 const auto end = initial_layout_map.end();
3544 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3545 pos->first.begin);
3546 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003547 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003548 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003549 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 -07003550 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003551 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003552 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003553 image_layout = current_layout->pos_B->lower_bound->second;
3554 }
3555 const auto intersected_range = pos->first & current_layout->range;
3556 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3557 // TODO: Set memory invalid which is in mem_tracker currently
3558 } else if (image_layout != initial_layout) {
3559 // Need to look up the inital layout *state* to get a bit more information
3560 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3561 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3562 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3563 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07003564 // We can report all the errors for the intersected range directly
3565 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
3566 const auto subresource = image_state->range_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003567 skip |= LogError(
3568 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003569 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003570 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07003571 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003572 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06003573 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003574 }
3575 }
John Zulauf2076e812020-01-08 14:55:54 -07003576 if (pos->first.includes(intersected_range.end)) {
3577 current_layout.seek(intersected_range.end);
3578 } else {
3579 ++pos;
3580 if (pos != end) {
3581 current_layout.seek(pos->first.begin);
3582 }
3583 }
John Zulauff660ad62019-03-23 07:16:05 -06003584 }
3585
locke-lunargf155ccf2020-02-18 11:34:15 -07003586 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003587 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003588 }
John Zulauff660ad62019-03-23 07:16:05 -06003589
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003590 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003591}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003592
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003593void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003594 for (const auto &layout_map_entry : pCB->image_layout_map) {
3595 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003596 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003597 const auto *image_state = GetImageState(image);
3598 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003599 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3600 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003601 }
3602}
3603
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003604// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003605// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3606// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003607bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3608 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003609 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003610 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003611 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3612
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003613 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07003614 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
3615 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003616 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003617 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3618 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3619 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003620 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
3621 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3622 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07003623 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3624 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
3625 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
3626 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3627 string_VkImageLayout(first_layout));
3628 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3629 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003630 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3631 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3632 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003633 }
3634 }
sfricke-samsung55f01952020-03-24 08:16:41 -07003635
3636 // Same as above for loadOp, but for stencilLoadOp
3637 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3638 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3639 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3640 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
3641 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
3642 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3643 string_VkImageLayout(first_layout));
3644 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3645 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
3646 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
3647 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3648 string_VkImageLayout(first_layout));
3649 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3650 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3651 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
3652 "Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003653 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003654 }
3655 }
3656
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003657 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003658}
3659
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003660bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3661 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003662 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003663 const char *vuid;
3664 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003665
Jason Ekstranda1906302017-12-03 20:16:32 -08003666 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3667 VkFormat format = pCreateInfo->pAttachments[i].format;
3668 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3669 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3670 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003671 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3672 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3673 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3674 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3675 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003676 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003677 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003678 skip |=
3679 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3680 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3681 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3682 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3683 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003684 }
3685 }
3686 }
3687
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003688 // Track when we're observing the first use of an attachment
3689 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3690 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003691 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003692
3693 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3694 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3695 auto attach_index = subpass.pInputAttachments[j].attachment;
3696 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003697 switch (subpass.pInputAttachments[j].layout) {
3698 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3699 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3700 // These are ideal.
3701 break;
3702
3703 case VK_IMAGE_LAYOUT_GENERAL:
3704 // May not be optimal. TODO: reconsider this warning based on other constraints.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003705 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3706 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
Cort Stratton7547f772017-05-04 15:18:52 -07003707 break;
3708
Tobias Hectorbbb12282018-10-22 15:17:59 +01003709 case VK_IMAGE_LAYOUT_UNDEFINED:
3710 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003711 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003712 skip |= LogError(device, vuid,
3713 "Layout for input attachment reference %u in subpass %u is %s but must be "
3714 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3715 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003716 break;
3717
Piers Daniell9af77cd2019-10-16 13:54:12 -06003718 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3719 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3720 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3721 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003722 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003723 skip |= LogError(
3724 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003725 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3726 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3727 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3728 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3729 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003730 skip |= LogError(
3731 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003732 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3733 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3734 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3735 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3736 } else if ((subpass.pInputAttachments[j].aspectMask &
3737 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3738 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3739 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3740 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3741 const auto *attachment_reference_stencil_layout =
3742 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3743 if (attachment_reference_stencil_layout) {
3744 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3745 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3746 attachment_reference_stencil_layout->stencilLayout ==
3747 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3748 attachment_reference_stencil_layout->stencilLayout ==
3749 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3750 attachment_reference_stencil_layout->stencilLayout ==
3751 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3752 attachment_reference_stencil_layout->stencilLayout ==
3753 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3754 attachment_reference_stencil_layout->stencilLayout ==
3755 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3756 attachment_reference_stencil_layout->stencilLayout ==
3757 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3758 attachment_reference_stencil_layout->stencilLayout ==
3759 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3760 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003761 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3762 "In the attachment reference %u in subpass %u with pNext chain instance "
3763 "VkAttachmentReferenceStencilLayoutKHR"
3764 "the stencilLayout member but must not be "
3765 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3766 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3767 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3768 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3769 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3770 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3771 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3772 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3773 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3774 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003775 }
3776 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003777 skip |= LogError(
3778 device, "VUID-VkAttachmentReference2-attachment-03315",
3779 "When the layout for input attachment reference %u in subpass %u is "
3780 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3781 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3782 "VkAttachmentReferenceStencilLayout instance.",
3783 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003784 }
3785 }
3786 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3787 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3788 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003789 skip |= LogError(
3790 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003791 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3792 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3793 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3794 j, i);
3795 }
3796 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3797 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3798 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003799 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3800 "When the aspectMask for input attachment reference %u in subpass %u is "
3801 "VK_IMAGE_ASPECT_STENCIL_BIT "
3802 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3803 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3804 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003805 }
3806 }
3807 break;
3808
Graeme Leese668a9862018-10-08 10:40:02 +01003809 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3810 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003811 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003812 break;
3813 } else {
3814 // Intentionally fall through to generic error message
3815 }
3816 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003817
Cort Stratton7547f772017-05-04 15:18:52 -07003818 default:
3819 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003820 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3821 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3822 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003823 }
3824
Cort Stratton7547f772017-05-04 15:18:52 -07003825 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003826 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3827 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003828
3829 bool used_as_depth =
3830 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3831 bool used_as_color = false;
3832 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3833 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3834 }
3835 if (!used_as_depth && !used_as_color &&
3836 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003837 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003838 skip |= LogError(device, vuid,
3839 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3840 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003841 }
3842 }
3843 attach_first_use[attach_index] = false;
3844 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003845
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003846 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3847 auto attach_index = subpass.pColorAttachments[j].attachment;
3848 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3849
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003850 // TODO: Need a way to validate shared presentable images here, currently just allowing
3851 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3852 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003853 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003854 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003855 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003856 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3857 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003858 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003859
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003860 case VK_IMAGE_LAYOUT_GENERAL:
3861 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003862 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3863 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003864 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003865
Tobias Hectorbbb12282018-10-22 15:17:59 +01003866 case VK_IMAGE_LAYOUT_UNDEFINED:
3867 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003868 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003869 skip |= LogError(device, vuid,
3870 "Layout for color attachment reference %u in subpass %u is %s but should be "
3871 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3872 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003873 break;
3874
Piers Daniell9af77cd2019-10-16 13:54:12 -06003875 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3876 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3877 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3878 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003879 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003880 skip |= LogError(
3881 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003882 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3883 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3884 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3885 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3886 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003887 skip |= LogError(
3888 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003889 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3890 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3891 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3892 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3893 } else if ((subpass.pColorAttachments[j].aspectMask &
3894 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3895 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3896 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3897 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3898 const auto *attachment_reference_stencil_layout =
3899 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3900 if (attachment_reference_stencil_layout) {
3901 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3902 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3903 attachment_reference_stencil_layout->stencilLayout ==
3904 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3905 attachment_reference_stencil_layout->stencilLayout ==
3906 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3907 attachment_reference_stencil_layout->stencilLayout ==
3908 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3909 attachment_reference_stencil_layout->stencilLayout ==
3910 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3911 attachment_reference_stencil_layout->stencilLayout ==
3912 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3913 attachment_reference_stencil_layout->stencilLayout ==
3914 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3915 attachment_reference_stencil_layout->stencilLayout ==
3916 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3917 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003918 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3919 "In the attachment reference %u in subpass %u with pNext chain instance "
3920 "VkAttachmentReferenceStencilLayoutKHR"
3921 "the stencilLayout member but must not be "
3922 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3923 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3924 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3925 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3926 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3927 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3928 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3929 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3930 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3931 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003932 }
3933 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003934 skip |= LogError(
3935 device, "VUID-VkAttachmentReference2-attachment-03315",
3936 "When the layout for color attachment reference %u in subpass %u is "
3937 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3938 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3939 "VkAttachmentReferenceStencilLayout instance.",
3940 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003941 }
3942 }
3943 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3944 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3945 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003946 skip |= LogError(
3947 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003948 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3949 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3950 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3951 j, i);
3952 }
3953 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3954 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3955 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003956 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3957 "When the aspectMask for color attachment reference %u in subpass %u is "
3958 "VK_IMAGE_ASPECT_STENCIL_BIT "
3959 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3960 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3961 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003962 }
3963 }
3964 break;
3965
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003966 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003967 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3968 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3969 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003970 }
3971
John Zulauf4eee2692019-02-09 16:14:25 -07003972 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3973 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3974 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003975 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003976 skip |= LogError(device, vuid,
3977 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
3978 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3979 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003980 }
3981
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003982 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003983 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3984 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003985 }
3986 attach_first_use[attach_index] = false;
3987 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003988
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003989 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3990 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003991 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3992 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3993 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003994 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003995
Dave Houltona9df0ce2018-02-07 10:51:23 -07003996 case VK_IMAGE_LAYOUT_GENERAL:
3997 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3998 // doing a bunch of transitions.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003999 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
4000 "GENERAL layout for depth attachment may not give optimal performance.");
Dave Houltona9df0ce2018-02-07 10:51:23 -07004001 break;
4002
Tobias Hectorbbb12282018-10-22 15:17:59 +01004003 case VK_IMAGE_LAYOUT_UNDEFINED:
4004 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004005 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004006 skip |= LogError(device, vuid,
4007 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
4008 "layout or GENERAL.",
4009 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004010 break;
4011
Piers Daniell9af77cd2019-10-16 13:54:12 -06004012 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4013 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4014 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4015 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004016 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004017 skip |= LogError(
4018 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004019 "Layout for depth attachment reference in subpass %u is %s but must not be "
4020 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4021 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4022 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
4023 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004024 skip |= LogError(
4025 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004026 "Layout for depth attachment reference in subpass %u is %s but must not be "
4027 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4028 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4029 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
4030 } else if ((subpass.pDepthStencilAttachment->aspectMask &
4031 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4032 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4033 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4034 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4035 const auto *attachment_reference_stencil_layout =
4036 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
4037 if (attachment_reference_stencil_layout) {
4038 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4039 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4040 attachment_reference_stencil_layout->stencilLayout ==
4041 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4042 attachment_reference_stencil_layout->stencilLayout ==
4043 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4044 attachment_reference_stencil_layout->stencilLayout ==
4045 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4046 attachment_reference_stencil_layout->stencilLayout ==
4047 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4048 attachment_reference_stencil_layout->stencilLayout ==
4049 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4050 attachment_reference_stencil_layout->stencilLayout ==
4051 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4052 attachment_reference_stencil_layout->stencilLayout ==
4053 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4054 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004055 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
4056 "In the attachment reference in subpass %u with pNext chain instance "
4057 "VkAttachmentReferenceStencilLayoutKHR"
4058 "the stencilLayout member but must not be "
4059 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4060 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4061 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4062 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4063 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4064 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4065 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4066 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4067 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
4068 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004069 }
4070 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004071 skip |= LogError(
4072 device, "VUID-VkAttachmentReference2-attachment-03315",
4073 "When the layout for depth attachment reference in subpass %u is "
4074 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4075 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4076 "VkAttachmentReferenceStencilLayout instance.",
4077 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004078 }
4079 }
4080 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4081 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4082 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004083 skip |= LogError(
4084 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004085 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
4086 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4087 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4088 i);
4089 }
4090 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4091 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4092 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004093 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
4094 "When the aspectMask for depth attachment reference in subpass %u is "
4095 "VK_IMAGE_ASPECT_STENCIL_BIT "
4096 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4097 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
4098 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004099 }
4100 }
4101 break;
4102
Dave Houltona9df0ce2018-02-07 10:51:23 -07004103 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4104 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004105 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004106 break;
4107 } else {
4108 // Intentionally fall through to generic error message
4109 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004110 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004111
Dave Houltona9df0ce2018-02-07 10:51:23 -07004112 default:
4113 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004114 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
4115 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4116 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
4117 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004118 }
4119
4120 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4121 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004122 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4123 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004124 }
4125 attach_first_use[attach_index] = false;
4126 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004127 }
4128 return skip;
4129}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004130
Mark Lobodzinski96210742017-02-09 10:33:46 -07004131// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4132// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004133template <typename T1>
4134bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4135 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4136 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004137 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004138 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004139 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004140 if (strict) {
4141 correct_usage = ((actual & desired) == desired);
4142 } else {
4143 correct_usage = ((actual & desired) != 0);
4144 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004145
Mark Lobodzinski96210742017-02-09 10:33:46 -07004146 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004147 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004148 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004149 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
4150 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4151 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004152 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004153 skip = LogError(object, msgCode,
4154 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4155 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004156 }
4157 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004158 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004159}
4160
4161// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4162// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004163bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004164 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004165 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004166 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004167}
4168
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004169bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004170 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004171 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004172 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4173 if ((image_format_features & desired) != desired) {
4174 // Same error, but more details if it was an AHB external format
4175 if (image_state->has_ahb_format == true) {
4176 skip |= LogError(image_state->image, vuid,
4177 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4178 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4179 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004180 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004181 } else {
4182 skip |= LogError(image_state->image, vuid,
4183 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4184 "with tiling %s.",
4185 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4186 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4187 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004188 }
4189 }
4190 return skip;
4191}
4192
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004193bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004194 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004195 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004196 // layerCount must not be zero
4197 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004198 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4199 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004200 }
4201 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4202 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004203 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4204 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004205 }
4206 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4207 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4208 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004209 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4210 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4211 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4212 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004213 }
4214 return skip;
4215}
4216
Mark Lobodzinski96210742017-02-09 10:33:46 -07004217// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4218// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004219bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004220 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004221 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004222 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004223}
4224
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004225bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004226 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004227 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004228
4229 const VkDeviceSize &range = pCreateInfo->range;
4230 if (range != VK_WHOLE_SIZE) {
4231 // Range must be greater than 0
4232 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004233 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
4234 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4235 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4236 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004237 }
4238 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004239 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4240 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004241 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
4242 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4243 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4244 "(%" PRIu32 ").",
4245 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004246 }
4247 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004248 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004249 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
4250 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4251 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4252 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4253 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004254 }
4255 // The sum of range and offset must be less than or equal to the size of buffer
4256 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004257 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
4258 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4259 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4260 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4261 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004262 }
4263 }
4264 return skip;
4265}
4266
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004267bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004268 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004269 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004270 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4271 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004272 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
4273 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4274 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004275 }
4276 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4277 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004278 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
4279 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4280 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004281 }
4282 return skip;
4283}
4284
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004285bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004286 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004287 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004288
Dave Houltond8ed0212018-05-16 17:18:24 -06004289 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004290
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004291 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004292 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4293 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4294 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004295 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004296
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004297 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004298 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4299 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4300 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004301 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004302
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004303 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004304 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4305 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4306 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004307 }
Jeff Bolz87697532019-01-11 22:54:00 -06004308
4309 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4310 if (chained_devaddr_struct) {
4311 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4312 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004313 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4314 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4315 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004316 }
4317 }
4318
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004319 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4320 if (chained_opaqueaddr_struct) {
4321 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4322 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004323 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4324 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4325 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004326 }
4327 }
4328
Shannon McPherson4984e642019-12-05 13:04:34 -07004329 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004330 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4331 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004332 skip |= LogError(
4333 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004334 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4335 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4336 }
4337
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004338 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004339 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4340 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4341 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004342 }
4343
Mark Lobodzinski96210742017-02-09 10:33:46 -07004344 return skip;
4345}
4346
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004347bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004348 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004349 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004350 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004351 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4352 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004353 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004354 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4355 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004356 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004357 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4358 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4359 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004360
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004361 // Buffer view offset must be less than the size of buffer
4362 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004363 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
4364 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4365 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4366 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004367 }
4368
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004369 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004370 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4371 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4372 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004373 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-02749",
4374 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4375 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4376 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004377 }
4378
4379 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4380 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4381 if ((elementSize % 3) == 0) {
4382 elementSize /= 3;
4383 }
4384 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4385 VkDeviceSize alignmentRequirement =
4386 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4387 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4388 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4389 }
4390 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004391 skip |= LogError(
4392 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004393 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4394 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4395 ") must be a multiple of the lesser of "
4396 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4397 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4398 "(%" PRId32
4399 ") is VK_TRUE, the size of a texel of the requested format. "
4400 "If the size of a texel is a multiple of three bytes, then the size of a "
4401 "single component of format is used instead",
4402 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4403 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4404 }
4405 }
4406 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4407 VkDeviceSize alignmentRequirement =
4408 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4409 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4410 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4411 }
4412 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004413 skip |= LogError(
4414 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004415 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4416 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4417 ") must be a multiple of the lesser of "
4418 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4419 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4420 "(%" PRId32
4421 ") is VK_TRUE, the size of a texel of the requested format. "
4422 "If the size of a texel is a multiple of three bytes, then the size of a "
4423 "single component of format is used instead",
4424 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4425 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4426 }
4427 }
4428 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004429
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004430 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004431
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004432 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004433 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004434 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004435}
4436
Mark Lobodzinski602de982017-02-09 11:01:33 -07004437// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004438bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004439 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004440 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004441 const IMAGE_STATE *image_state = GetImageState(image);
4442 // checks color format and (single-plane or non-disjoint)
4443 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004444 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004445 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004446 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 -07004447 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004448 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 -07004449 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004450 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004451 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004452 skip |= LogError(image, vuid,
4453 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4454 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4455 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004456 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004457 skip |= LogError(image, vuid,
4458 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4459 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4460 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004461 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004462 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004463 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004464 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 -07004465 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004466 skip |=
4467 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 -07004468 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004469 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004470 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004471 skip |=
4472 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 -07004473 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004474 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4475 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004476 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004477 } else if (FormatIsMultiplane(format)) {
4478 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4479 if (3 == FormatPlaneCount(format)) {
4480 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4481 }
4482 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004483 skip |=
4484 LogError(image, vuid,
4485 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4486 "set, where n = [0, 1, 2].",
4487 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004488 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004489 }
4490 return skip;
4491}
4492
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004493bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4494 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004495 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4496 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004497 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004498
4499 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004500 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004501 skip |= LogError(image, errorCodes.base_mip_err,
4502 "%s: %s.baseMipLevel (= %" PRIu32
4503 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4504 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004505 }
Petr Kraus4d718682017-05-18 03:38:41 +02004506
Petr Krausffa94af2017-08-08 21:46:02 +02004507 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4508 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004509 skip |= LogError(image, errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004510 } else {
4511 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004512
Petr Krausffa94af2017-08-08 21:46:02 +02004513 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004514 skip |= LogError(image, errorCodes.mip_count_err,
4515 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4516 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4517 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4518 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004519 }
Petr Kraus4d718682017-05-18 03:38:41 +02004520 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004521 }
Petr Kraus4d718682017-05-18 03:38:41 +02004522
4523 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004524 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004525 skip |= LogError(image, errorCodes.base_layer_err,
4526 "%s: %s.baseArrayLayer (= %" PRIu32
4527 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4528 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004529 }
Petr Kraus4d718682017-05-18 03:38:41 +02004530
Petr Krausffa94af2017-08-08 21:46:02 +02004531 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4532 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004533 skip |= LogError(image, errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004534 } else {
4535 const uint64_t necessary_layer_count =
4536 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004537
Petr Krausffa94af2017-08-08 21:46:02 +02004538 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004539 skip |= LogError(image, errorCodes.layer_count_err,
4540 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4541 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4542 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4543 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004544 }
Petr Kraus4d718682017-05-18 03:38:41 +02004545 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004546 }
Petr Kraus4d718682017-05-18 03:38:41 +02004547
Mark Lobodzinski602de982017-02-09 11:01:33 -07004548 return skip;
4549}
4550
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004551bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004552 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004553 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004554 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4555 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4556 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4557
4558 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4559 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4560
4561 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004562 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4563 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004564 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004565 : "VUID-VkImageViewCreateInfo-image-01482")
4566 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4567 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004568 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004569 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4570 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004571
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004572 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004573 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004574 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004575}
4576
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004577bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004578 const VkImageSubresourceRange &subresourceRange,
4579 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004580 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004581 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4582 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4583 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4584 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004585
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004586 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004587 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004588 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004589}
4590
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004591bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004592 const VkImageSubresourceRange &subresourceRange,
4593 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004594 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004595 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4596 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4597 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4598 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004599
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004600 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004601 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4602 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004603}
4604
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004605bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004606 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004607 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004608 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004609 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4610 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4611 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4612 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004613
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004614 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004615 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004616}
4617
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004618bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4619 const VkImageUsageFlags image_usage) const {
4620 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4621 bool skip = false;
4622
4623 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4624 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4625
4626 if (image_state->has_ahb_format == true) {
4627 // AHB image view and image share same feature sets
4628 tiling_features = image_state->format_features;
4629 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4630 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4631 assert(device_extensions.vk_ext_image_drm_format_modifier);
4632 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4633 nullptr};
4634 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4635
4636 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4637 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4638 nullptr};
4639 format_properties_2.pNext = (void *)&drm_properties_list;
4640 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4641
4642 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4643 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4644 0) {
4645 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4646 }
4647 }
4648 } else {
4649 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4650 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4651 : format_properties.optimalTilingFeatures;
4652 }
4653
4654 if (tiling_features == 0) {
4655 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4656 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4657 "physical device.",
4658 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4659 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4660 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4661 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4662 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4663 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4664 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4665 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4666 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4667 "VK_IMAGE_USAGE_STORAGE_BIT.",
4668 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4669 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4670 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4671 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4672 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4673 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4674 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4675 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4676 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4677 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4678 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4679 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4680 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4681 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4682 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4683 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4684 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4685 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4686 }
4687
4688 return skip;
4689}
4690
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004691bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004692 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004693 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004694 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004695 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004696 skip |=
4697 ValidateImageUsageFlags(image_state,
4698 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4699 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4700 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4701 false, kVUIDUndefined, "vkCreateImageView()",
4702 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4703 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004704 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004705 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004706 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004707 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004708 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004709 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004710
4711 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4712 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004713 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004714 VkFormat view_format = pCreateInfo->format;
4715 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004716 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004717 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004718
Dave Houltonbd2e2622018-04-10 16:41:14 -06004719 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004720 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004721 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004722 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004723 if (!device_extensions.vk_ext_separate_stencil_usage) {
4724 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004725 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4726 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4727 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004728 }
4729 } else {
4730 const auto image_stencil_struct =
4731 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4732 if (image_stencil_struct == nullptr) {
4733 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004734 skip |= LogError(
4735 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004736 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4737 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4738 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4739 }
4740 } else {
4741 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4742 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4743 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004744 skip |= LogError(
4745 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004746 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4747 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4748 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4749 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4750 }
4751 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4752 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004753 skip |= LogError(
4754 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004755 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4756 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4757 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4758 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4759 }
4760 }
4761 }
4762 }
4763
Dave Houltonbd2e2622018-04-10 16:41:14 -06004764 image_usage = chained_ivuci_struct->usage;
4765 }
4766
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004767 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4768 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004769 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004770 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004771 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004772 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004773 std::stringstream ss;
4774 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004775 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004776 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004777 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004778 }
4779 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004780 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06004781 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4782 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004783 const char *error_vuid;
4784 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4785 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4786 } else if ((device_extensions.vk_khr_maintenance2) &&
4787 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4788 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4789 } else if ((!device_extensions.vk_khr_maintenance2) &&
4790 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4791 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4792 } else {
4793 // both enabled
4794 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4795 }
Dave Houltonc7988072018-04-16 11:46:56 -06004796 std::stringstream ss;
4797 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004798 << " is not in the same format compatibility class as "
4799 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004800 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4801 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004802 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004803 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004804 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004805 }
4806 } else {
4807 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004808 // Unless it is a multi-planar color bit aspect
4809 if ((image_format != view_format) &&
4810 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4811 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4812 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004813 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004814 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004815 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004816 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004817 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004818 }
4819 }
4820
4821 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004822 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004823
4824 switch (image_type) {
4825 case VK_IMAGE_TYPE_1D:
4826 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004827 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4828 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4829 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004830 }
4831 break;
4832 case VK_IMAGE_TYPE_2D:
4833 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4834 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4835 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004836 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4837 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4838 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004839 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004840 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4841 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4842 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004843 }
4844 }
4845 break;
4846 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004847 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004848 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4849 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4850 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004851 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004852 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4853 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4854 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004855 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4856 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004857 skip |= LogError(
4858 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4859 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4860 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4861 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4862 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004863 }
4864 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004865 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4866 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4867 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004868 }
4869 }
4870 } else {
4871 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004872 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4873 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4874 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004875 }
4876 }
4877 break;
4878 default:
4879 break;
4880 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004881
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004882 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004883 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004884 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004885 }
4886
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004887 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004888
Jeff Bolz9af91c52018-09-01 21:53:57 -05004889 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4890 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004891 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4892 "vkCreateImageView() If image was created with usage containing "
4893 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4894 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004895 }
4896 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004897 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4898 "vkCreateImageView() If image was created with usage containing "
4899 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004900 }
4901 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05004902
4903 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
4904 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
4905 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
4906 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
4907 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
4908 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
4909 }
4910 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
4911 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
4912 skip |= LogError(
4913 device, "VUID-VkImageViewCreateInfo-viewType-02963",
4914 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
4915 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
4916 }
4917 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004918 }
4919 return skip;
4920}
4921
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004922bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4923 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004924 bool skip = false;
4925
4926 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4927 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4928 VkDeviceSize src_min = UINT64_MAX;
4929 VkDeviceSize src_max = 0;
4930 VkDeviceSize dst_min = UINT64_MAX;
4931 VkDeviceSize dst_max = 0;
4932
4933 for (uint32_t i = 0; i < regionCount; i++) {
4934 src_min = std::min(src_min, pRegions[i].srcOffset);
4935 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4936 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4937 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4938
4939 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4940 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004941 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
4942 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4943 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4944 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004945 }
4946
4947 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4948 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004949 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
4950 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4951 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4952 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004953 }
4954
4955 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4956 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004957 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
4958 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4959 ") is greater than the source buffer size (%" PRIuLEAST64
4960 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4961 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004962 }
4963
4964 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4965 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004966 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
4967 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4968 ") is greater than the destination buffer size (%" PRIuLEAST64
4969 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4970 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004971 }
4972 }
4973
4974 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4975 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4976 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004977 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
4978 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004979 }
4980 }
4981
4982 return skip;
4983}
4984
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004985bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004986 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004987 const auto cb_node = GetCBState(commandBuffer);
4988 const auto src_buffer_state = GetBufferState(srcBuffer);
4989 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004990
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004991 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004992 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4993 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004994 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004995 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004996 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4997 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004998 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004999 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5000 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005001 skip |=
5002 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5003 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005004 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5005 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005006 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005007 return skip;
5008}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005009
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005010bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005011 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005012 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005013 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005014 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
5015 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005016 } else {
5017 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005018 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5019 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005020 }
5021 }
5022 return skip;
5023}
5024
Jeff Bolz5c801d12019-10-09 10:38:45 -05005025bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5026 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005027 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005028 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005029
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005030 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005031 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005032 skip |=
5033 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005034 }
5035 return skip;
5036}
5037
Jeff Bolz5c801d12019-10-09 10:38:45 -05005038bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005039 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005040
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005041 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005042 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005043 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005044 }
5045 return skip;
5046}
5047
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005048bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005049 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005050 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005051 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005052 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005053 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005054 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005055 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005056 }
5057 return skip;
5058}
5059
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005060bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005061 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005062 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005063 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005064 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005065 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005066 skip |=
5067 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5068 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005069 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005070 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005071 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5072 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005073 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005074
5075 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005076 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5077 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5078 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5079 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005080 }
5081
5082 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005083 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5084 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5085 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5086 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005087 }
5088
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005089 return skip;
5090}
5091
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005092bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
5093 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005094 bool skip = false;
5095
5096 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005097 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5098 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005099 skip |=
5100 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
5101 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5102 "and 1, respectively.",
5103 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005104 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005105 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005106
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005107 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5108 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005109 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
5110 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
5111 "must be 0 and 1, respectively.",
5112 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005113 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005114 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005115
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005116 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5117 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005118 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
5119 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5120 "For 3D images these must be 0 and 1, respectively.",
5121 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005122 }
5123 }
5124
5125 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005126 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07005127 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
5128
Dave Houltona585d132019-01-18 13:05:42 -07005129 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005130 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00193",
5131 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5132 " must be a multiple of this format's texel size (%" PRIu32 ").",
5133 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005134 }
5135
5136 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06005137 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005138 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00194",
5139 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
5140 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005141 }
5142
5143 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5144 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005145 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005146 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
5147 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5148 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005149 }
5150
5151 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5152 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005153 skip |= LogError(
5154 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005155 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5156 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005157 }
5158
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005159 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005160 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005161 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005162 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 -06005163 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5164 static_cast<int32_t>(adjusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005165 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
5166 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5167 "zero or <= image subresource width (%d).",
5168 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005169 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005170 }
5171
5172 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005173 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 -06005174 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5175 static_cast<int32_t>(adjusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005176 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
5177 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5178 "zero or <= image subresource height (%d).",
5179 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005180 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005181 }
5182
5183 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005184 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 -06005185 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5186 static_cast<int32_t>(adjusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005187 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
5188 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5189 "zero or <= image subresource depth (%d).",
5190 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005191 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005192 }
5193
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005194 // subresource aspectMask must have exactly 1 bit set
5195 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
5196 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
5197 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005198 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
5199 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005200 }
5201
5202 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06005203 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005204 skip |= LogError(
5205 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005206 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5207 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005208 }
5209
5210 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04005211 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005212 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005213
5214 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005215 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005216 skip |= LogError(
5217 image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005218 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5219 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005220 }
5221
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005222 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005223 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005224 skip |= LogError(
5225 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005226 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5227 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005228 }
5229
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005230 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005231 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5232 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5233 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005234 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00205",
5235 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5236 "width & height (%d, %d)..",
5237 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5238 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005239 }
5240
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005241 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07005242 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005243 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005244 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00206",
5245 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5246 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5247 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005248 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005249
5250 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005251 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005252 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005253 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005254 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00207",
5255 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5256 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5257 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5258 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005259 }
5260
5261 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005262 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005263 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005264 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00208",
5265 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5266 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5267 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5268 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005269 }
5270
5271 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005272 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005273 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005274 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00209",
5275 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5276 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5277 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5278 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005279 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005280 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005281
5282 // Checks that apply only to multi-planar format images
5283 if (FormatIsMultiplane(image_state->createInfo.format)) {
5284 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5285 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5286 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005287 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5288 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5289 "format has three planes.",
5290 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005291 }
5292
5293 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5294 if (0 == (pRegions[i].imageSubresource.aspectMask &
5295 (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 -07005296 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5297 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5298 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5299 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005300 }
5301 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005302 }
5303
5304 return skip;
5305}
5306
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005307bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5308 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005309 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005310 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005311
5312 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005313 VkExtent3D extent = pRegions[i].imageExtent;
5314 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005315
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005316 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5317 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005318 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5319 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5320 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005321 }
5322
5323 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5324
5325 // 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 -06005326 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005327 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005328 if (image_extent.width % block_extent.width) {
5329 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5330 }
5331 if (image_extent.height % block_extent.height) {
5332 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5333 }
5334 if (image_extent.depth % block_extent.depth) {
5335 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5336 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005337 }
5338
Dave Houltonfc1a4052017-04-27 14:32:45 -06005339 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005340 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005341 }
5342 }
5343
5344 return skip;
5345}
5346
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005347bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5348 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005349 bool skip = false;
5350
5351 VkDeviceSize buffer_size = buff_state->createInfo.size;
5352
5353 for (uint32_t i = 0; i < regionCount; i++) {
5354 VkExtent3D copy_extent = pRegions[i].imageExtent;
5355
5356 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5357 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005358 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5359 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005360
Tom Cooperb2550c72018-10-15 13:08:41 +01005361 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005362 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005363 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005364 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5365 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5366
5367 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5368 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5369 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005370 }
5371
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005372 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5373 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5374 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005375 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005376 } else {
5377 // Calculate buffer offset of final copied byte, + 1.
5378 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5379 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5380 max_buffer_offset *= unit_size; // convert to bytes
5381 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005382
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005383 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005384 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5385 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005386 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005387 }
5388 }
5389
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005390 return skip;
5391}
5392
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005393bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005394 VkBuffer dstBuffer, uint32_t regionCount,
5395 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005396 const auto cb_node = GetCBState(commandBuffer);
5397 const auto src_image_state = GetImageState(srcImage);
5398 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005399
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005400 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005401
5402 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005403 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005404
5405 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005406 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005407
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005408 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005409
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005410 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005411 skip |=
5412 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5413 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5414 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005415 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005416 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005417 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005418 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005419 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005420
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005421 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005422 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005423 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5424 skip |=
5425 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005426
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005427 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005428 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005429 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5430 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005431 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005432 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5433 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005434 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005435 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005436 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005437 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005438 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005439 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005440 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5441 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5442 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005443 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005444 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005445 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005446 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005447 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5448 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005449 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5450 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5451 skip |=
5452 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5453 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5454 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005455 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5456 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005457 }
5458 return skip;
5459}
5460
John Zulauf1686f232019-07-09 16:27:11 -06005461void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5462 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5463 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5464
5465 auto cb_node = GetCBState(commandBuffer);
5466 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005467 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005468 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005469 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005470 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005471}
5472
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005473bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5474 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005475 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005476 const auto cb_node = GetCBState(commandBuffer);
5477 const auto src_buffer_state = GetBufferState(srcBuffer);
5478 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005479
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005480 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005481
5482 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005483 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005484
5485 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005486 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005487 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005488 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005489 skip |=
5490 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5491 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5492 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005493 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005494 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005495 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005496 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005497 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005498 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005499 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005500 skip |=
5501 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5502 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005503 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005504 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5505 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005506 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005507 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5508 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005509 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005510 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005511 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005512 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005513 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005514 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005515 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5516 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5517 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005518 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005519 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005520 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005521 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005522 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5523 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005524 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5525 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5526 skip |=
5527 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5528 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5529 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005530 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5531 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005532 }
5533 return skip;
5534}
5535
John Zulauf1686f232019-07-09 16:27:11 -06005536void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5537 VkImageLayout dstImageLayout, uint32_t regionCount,
5538 const VkBufferImageCopy *pRegions) {
5539 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5540
5541 auto cb_node = GetCBState(commandBuffer);
5542 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005543 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005544 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005545 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005546 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005547}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005548
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005549bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005550 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005551 bool skip = false;
5552 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5553
Dave Houlton1d960ff2018-01-19 12:17:05 -07005554 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005555 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5556 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5557 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005558 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5559 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005560 }
5561
John Zulaufa26d3c82019-08-14 16:09:08 -06005562 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005563 if (!image_entry) {
5564 return skip;
5565 }
5566
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005567 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5568 if (device_extensions.vk_ext_image_drm_format_modifier) {
5569 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5570 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005571 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5572 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5573 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005574 }
5575 } else {
5576 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005577 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5578 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005579 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005580 }
5581
Dave Houlton1d960ff2018-01-19 12:17:05 -07005582 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005583 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005584 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5585 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5586 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005587 }
5588
Dave Houlton1d960ff2018-01-19 12:17:05 -07005589 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005590 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005591 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5592 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5593 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005594 }
5595
Dave Houlton1d960ff2018-01-19 12:17:05 -07005596 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005597 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005598 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5599 if (FormatIsMultiplane(img_format)) {
5600 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5601 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5602 if (FormatPlaneCount(img_format) > 2u) {
5603 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5604 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5605 }
5606 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005607 skip |= LogError(image, vuid,
5608 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5609 ") must be a single-plane specifier flag.",
5610 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005611 }
5612 } else if (FormatIsColor(img_format)) {
5613 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005614 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5615 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5616 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005617 }
5618 } else if (FormatIsDepthOrStencil(img_format)) {
5619 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5620 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005621 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005622 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5623 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5624 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5625 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005626 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5627 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5628 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005629 }
5630 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005631
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005632 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005633 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005634 }
5635
Mike Weiblen672b58b2017-02-21 14:32:53 -07005636 return skip;
5637}