blob: 9eefdd1d3102075dc0506e57b80a9dbf8921a71e [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
John Zulauf2be3fe02019-12-30 09:48:02 -07001188 if (is_release_op) {
1189 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1190 } else {
1191 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1192 }
unknown86bcb3a2019-07-11 13:05:36 -06001193}
1194
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001195bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1196 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1197 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1198 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001199 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001200 assert(cb_node);
1201 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001202 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001203 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001204
John Zulauff660ad62019-03-23 07:16:05 -06001205 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1206 if (subresource_map) {
1207 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001208 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001209 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1210 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001211 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001212 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1213 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1214 "%s layout %s.",
1215 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1216 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1217 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001218 }
John Zulauf5e617452019-11-19 14:44:16 -07001219 }
John Zulauff660ad62019-03-23 07:16:05 -06001220 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001221 }
John Zulauff660ad62019-03-23 07:16:05 -06001222
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001223 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1224 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1225 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001226 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1227 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001228 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1229 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1230 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001231 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001232 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001233 if (image_state->shared_presentable) {
1234 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001235 skip |= LogError(device, layout_invalid_msg_code,
1236 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1237 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001238 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001239 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001240 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001241 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001242 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1243 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1244 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1245 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001246 }
1247 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001248 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001249}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001250bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001251 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1252 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001253 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001254 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1255 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1256}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001257
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001258void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001259 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001260 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001261 if (!renderPass) return;
1262
Tobias Hectorbbb12282018-10-22 15:17:59 +01001263 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001264 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001265 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001266 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001267 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1268 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1269 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1270 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001271 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001272 }
John Zulauf8e308292018-09-21 11:34:37 -06001273 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001274 VkImageLayout stencil_layout = kInvalidLayout;
1275 const auto *attachment_description_stencil_layout =
1276 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1277 if (attachment_description_stencil_layout) {
1278 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1279 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001280 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001281 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001282 }
1283 }
1284}
Dave Houltone19e20d2018-02-02 16:32:41 -07001285
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001286#ifdef VK_USE_PLATFORM_ANDROID_KHR
1287// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1288// This could also move into a seperate core_validation_android.cpp file... ?
1289
1290//
1291// AHB-specific validation within non-AHB APIs
1292//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001293bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001294 bool skip = false;
1295
1296 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1297 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001298 if (0 != ext_fmt_android->externalFormat) {
1299 if (VK_FORMAT_UNDEFINED != create_info->format) {
1300 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001301 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1302 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1303 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001304 }
1305
1306 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001307 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1308 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1309 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001310 }
1311
1312 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001313 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1314 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001315 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1316 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1317 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001318 }
1319
1320 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001321 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1322 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1323 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001324 }
1325 }
1326
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001327 if ((0 != ext_fmt_android->externalFormat) &&
1328 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001329 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001330 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1331 ") which has "
1332 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1333 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001334 }
1335 }
1336
Dave Houltond9611312018-11-19 17:03:36 -07001337 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001338 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001339 skip |=
1340 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1341 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1342 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001343 }
1344 }
1345
1346 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1347 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1348 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001349 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001350 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1351 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1352 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1353 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001354 }
1355
1356 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001357 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1358 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1359 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1360 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1361 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001362 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001363 }
1364
1365 return skip;
1366}
1367
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001368bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001369 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001370 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001371
1372 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001373 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001374 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1375 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001376 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001377 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001378 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001379
Dave Houltond9611312018-11-19 17:03:36 -07001380 // Chain must include a compatible ycbcr conversion
1381 bool conv_found = false;
1382 uint64_t external_format = 0;
1383 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1384 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001385 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001386 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001387 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001388 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001389 }
Dave Houltond9611312018-11-19 17:03:36 -07001390 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001391 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001392 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001393 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1394 "an externalFormat (%" PRIu64
1395 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1396 "with the same external format.",
1397 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001398 }
1399
1400 // Errors in create_info swizzles
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001401 if (((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1402 (create_info->components.r != VK_COMPONENT_SWIZZLE_R)) ||
1403 ((create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1404 (create_info->components.g != VK_COMPONENT_SWIZZLE_G)) ||
1405 ((create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1406 (create_info->components.b != VK_COMPONENT_SWIZZLE_B)) ||
1407 ((create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1408 (create_info->components.a != VK_COMPONENT_SWIZZLE_A))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001409 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1410 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1411 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001412 }
1413 }
Dave Houltond9611312018-11-19 17:03:36 -07001414
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001415 return skip;
1416}
1417
John Zulaufa26d3c82019-08-14 16:09:08 -06001418bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001419 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001420
John Zulaufa26d3c82019-08-14 16:09:08 -06001421 const IMAGE_STATE *image_state = GetImageState(image);
Spencer Fricke224c9852020-04-06 07:47:29 -07001422 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001423 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1424 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1425 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1426 "bound to memory.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001427 }
1428 return skip;
1429}
1430
1431#else
1432
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001433bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001434 return false;
1435}
1436
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001437bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001438
John Zulaufa26d3c82019-08-14 16:09:08 -06001439bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001440
1441#endif // VK_USE_PLATFORM_ANDROID_KHR
1442
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001443bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1444 bool skip = false;
1445
1446 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1447 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1448 const VkImageTiling image_tiling = pCreateInfo->tiling;
1449 const VkFormat image_format = pCreateInfo->format;
1450
1451 if (image_format == VK_FORMAT_UNDEFINED) {
1452 // VU 01975 states format can't be undefined unless an android externalFormat
1453#ifdef VK_USE_PLATFORM_ANDROID_KHR
1454 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1455 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1456 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1457 if (it != ahb_ext_formats_map.end()) {
1458 tiling_features = it->second;
1459 }
1460 }
1461#endif
1462 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1463 uint64_t drm_format_modifier = 0;
1464 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1465 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1466 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1467 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1468
1469 if (drm_explicit != nullptr) {
1470 drm_format_modifier = drm_explicit->drmFormatModifier;
1471 } else {
1472 // VUID 02261 makes sure its only explict or implict in parameter checking
1473 assert(drm_implicit != nullptr);
1474 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1475 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1476 }
1477 }
1478
1479 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1480 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1481 nullptr};
1482 format_properties_2.pNext = (void *)&drm_properties_list;
1483 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
1484
1485 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1486 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1487 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1488 }
1489 }
1490 } else {
1491 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1492 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1493 : format_properties.optimalTilingFeatures;
1494 }
1495
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001496 // Lack of disjoint format feature support while using the flag
1497 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1498 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1499 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1500 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1501 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1502 string_VkFormat(pCreateInfo->format));
1503 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001504
1505 return skip;
1506}
1507
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001508bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001509 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001510 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001511
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001512 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001513 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001514 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1515 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001516 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1517 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001518 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001519 }
1520
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001521 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1522 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001523 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1524 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1525 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001526 }
1527
1528 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001529 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1530 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1531 "height (%d) and arrayLayers (%d) must be >= 6.",
1532 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001533 }
Dave Houlton130c0212018-01-29 13:39:56 -07001534 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001535
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001536 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001537 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1538 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1539 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001540 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1541 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1542 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001543 }
1544
1545 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001546 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1547 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1548 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001549 }
1550
ByumjinConffx991b6062019-08-14 15:17:53 -07001551 if (device_extensions.vk_ext_fragment_density_map) {
1552 uint32_t ceiling_width =
1553 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1554 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1555 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1556 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001557 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1558 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1559 "ceiling of device "
1560 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1561 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1562 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001563 }
1564
1565 uint32_t ceiling_height =
1566 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1567 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1568 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1569 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001570 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1571 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1572 "ceiling of device "
1573 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1574 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1575 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001576 }
1577 }
1578
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001579 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001580 VkResult result = VK_SUCCESS;
1581 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1582 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1583 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1584 &format_limits);
1585 } else {
1586 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1587 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1588 image_format_info.type = pCreateInfo->imageType;
1589 image_format_info.tiling = pCreateInfo->tiling;
1590 image_format_info.usage = pCreateInfo->usage;
1591 image_format_info.flags = pCreateInfo->flags;
1592 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1593 format_limits = image_format_properties.imageFormatProperties;
1594 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001595
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001596 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001597#ifdef VK_USE_PLATFORM_ANDROID_KHR
1598 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1599#endif // VK_USE_PLATFORM_ANDROID_KHR
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001600 skip |= LogError(device, kVUID_Core_Image_FormatNotSupported,
1601 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
1602 "VkGetPhysicalDeviceImageFormatProperties returned back VK_ERROR_FORMAT_NOT_SUPPORTED.",
1603 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001604 } else {
1605 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1606 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001607 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1608 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1609 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001610 }
Dave Houlton130c0212018-01-29 13:39:56 -07001611
Dave Houltona585d132019-01-18 13:05:42 -07001612 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1613 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1614 (uint64_t)pCreateInfo->samples;
1615 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001616
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001617 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001618 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001619 uint64_t ig_mask = imageGranularity - 1;
1620 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001621
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001622 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001623 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1624 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1625 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1626 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001627 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001628
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001629 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001630 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1631 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1632 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001633 }
1634
1635 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001636 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1637 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1638 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001639 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001640 }
1641
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001642 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001643 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1644 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1645 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1646 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001647 skip |= LogError(device, error_vuid,
1648 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1649 "YCbCr Conversion format, arrayLayers must be 1",
1650 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001651 }
1652
1653 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001654 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1655 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1656 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001657 }
1658
1659 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001660 skip |= LogError(
1661 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001662 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1663 string_VkSampleCountFlagBits(pCreateInfo->samples));
1664 }
1665
1666 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001667 skip |= LogError(
1668 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001669 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1670 string_VkImageType(pCreateInfo->imageType));
1671 }
1672 }
1673
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001674 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001675 skip |=
1676 LogError(device, "VUID-VkImageCreateInfo-flags-01924",
1677 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1678 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001679 }
1680
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001681 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001682 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001683 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1684 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001685 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1686 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1687 "format must be block, ETC or ASTC compressed, but is %s",
1688 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001689 }
1690 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001691 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1692 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1693 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001694 }
1695 }
1696 }
1697
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001698 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001699 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1700 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1701 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001702 }
1703
unknown2c877272019-07-11 12:56:50 -06001704 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1705 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1706 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001707 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1708 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1709 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001710 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001711
1712 skip |= ValidateImageFormatFeatures(pCreateInfo);
1713
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001714 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001715}
1716
John Zulauf7eeb6f72019-06-17 11:56:36 -06001717void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1718 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1719 if (VK_SUCCESS != result) return;
1720
1721 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001722 auto image_state = Get<IMAGE_STATE>(*pImage);
1723 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001724}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001725
Jeff Bolz5c801d12019-10-09 10:38:45 -05001726bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001727 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001728 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001729 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001730 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001731 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001732 }
1733 return skip;
1734}
1735
John Zulauf7eeb6f72019-06-17 11:56:36 -06001736void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1737 // Clean up validation specific data
1738 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001739
locke-lunargcba7d5f2019-12-30 16:59:11 -07001740 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001741
1742 // Clean up generic image state
1743 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001744}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001745
John Zulauf07288512019-07-05 11:09:50 -06001746bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001747 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001748
1749 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1750 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 -07001751 skip |= LogError(image_state->image, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001752 }
1753
Dave Houlton1d2022c2017-03-29 11:43:58 -06001754 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001755 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001756 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001757 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001758 char const str[] = "vkCmdClearColorImage called with compressed image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001759 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001760 }
1761
1762 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1763 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001764 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001765 }
1766 return skip;
1767}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001768
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001769uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1770 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1771 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001772 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001773 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001774 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001775 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001776}
1777
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001778uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1779 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1780 uint32_t array_layer_count = range->layerCount;
1781 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1782 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001783 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001784 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001785}
1786
John Zulauf07288512019-07-05 11:09:50 -06001787bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1788 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1789 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001790 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001791 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1792 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001793 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1794 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1795 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001796 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001797
1798 } else {
1799 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1800 if (!device_extensions.vk_khr_shared_presentable_image) {
1801 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001802 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1803 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1804 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001805 }
1806 } else {
1807 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1808 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001809 skip |= LogError(
1810 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001811 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1812 func_name, string_VkImageLayout(dest_image_layout));
1813 }
1814 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001815 }
1816
John Zulauff660ad62019-03-23 07:16:05 -06001817 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001818 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001819 if (subresource_map) {
1820 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001821 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001822 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001823 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1824 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001825 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1826 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1827 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1828 } else {
1829 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001830 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001831 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1832 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1833 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1834 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001835 }
John Zulauf5e617452019-11-19 14:44:16 -07001836 }
John Zulauff660ad62019-03-23 07:16:05 -06001837 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001838 }
1839
1840 return skip;
1841}
1842
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001843bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1844 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001845 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001846 bool skip = false;
1847 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001848 const auto *cb_node = GetCBState(commandBuffer);
1849 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001850 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001851 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001852 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001853 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001854 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001855 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001856 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1857 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001858 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001859 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001860 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001861 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001862 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001863 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1864 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001865 }
sfricke-samsunge775d492020-02-28 09:02:25 -08001866 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
1867 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
1868 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
1869 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
1870 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
1871 string_VkFormat(image_state->createInfo.format));
1872 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001873 }
1874 return skip;
1875}
1876
John Zulaufeabb4462019-07-05 14:13:03 -06001877void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1878 const VkClearColorValue *pColor, uint32_t rangeCount,
1879 const VkImageSubresourceRange *pRanges) {
1880 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1881
1882 auto cb_node = GetCBState(commandBuffer);
1883 auto image_state = GetImageState(image);
1884 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001885 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001886 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001887 }
1888 }
1889}
1890
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001891bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1892 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001893 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001894 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001895
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001896 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001897 const auto *cb_node = GetCBState(commandBuffer);
1898 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001899 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001900 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001901 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001902 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001903 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001904 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001905 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001906 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001907 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001908 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001909 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001910
1911 bool any_include_aspect_depth_bit = false;
1912 bool any_include_aspect_stencil_bit = false;
1913
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001914 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001915 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001916 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001917 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001918 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001919 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1920 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001921 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001922 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1923 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001924 skip |= LogError(commandBuffer, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001925 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001926 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1927 any_include_aspect_depth_bit = true;
1928 }
1929 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1930 any_include_aspect_stencil_bit = true;
1931 }
1932 }
1933 if (any_include_aspect_stencil_bit) {
1934 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1935 if (image_stencil_struct != nullptr) {
1936 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1937 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001938 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1939 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1940 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1941 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001942 }
1943 } else {
1944 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001945 skip |= LogError(
1946 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05001947 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1948 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1949 "in VkImageCreateInfo::usage used to create image");
1950 }
1951 }
1952 }
1953 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001954 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1955 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1956 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001957 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001958 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001959 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001960 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001961 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001962 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1963 char const str[] =
1964 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1965 "set.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001966 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001967 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001968 }
1969 return skip;
1970}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001971
John Zulaufeabb4462019-07-05 14:13:03 -06001972void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1973 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1974 const VkImageSubresourceRange *pRanges) {
1975 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1976 auto cb_node = GetCBState(commandBuffer);
1977 auto image_state = GetImageState(image);
1978 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001979 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001980 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001981 }
1982 }
1983}
1984
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001985// Returns true if [x, xoffset] and [y, yoffset] overlap
1986static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1987 bool result = false;
1988 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1989 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1990
1991 if (intersection_max > intersection_min) {
1992 result = true;
1993 }
1994 return result;
1995}
1996
Dave Houltonc991cc92018-03-06 11:08:51 -07001997// Returns true if source area of first copy region intersects dest area of second region
1998// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1999static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002000 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002001
Dave Houltonc991cc92018-03-06 11:08:51 -07002002 // Separate planes within a multiplane image cannot intersect
2003 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002004 return result;
2005 }
2006
Dave Houltonc991cc92018-03-06 11:08:51 -07002007 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2008 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2009 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002010 result = true;
2011 switch (type) {
2012 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002013 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002014 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002015 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002016 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002017 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002018 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002019 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002020 break;
2021 default:
2022 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2023 assert(false);
2024 }
2025 }
2026 return result;
2027}
2028
Dave Houltonfc1a4052017-04-27 14:32:45 -06002029// Returns non-zero if offset and extent exceed image extents
2030static const uint32_t x_bit = 1;
2031static const uint32_t y_bit = 2;
2032static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002033static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002034 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002035 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002036 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2037 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002038 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002039 }
2040 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2041 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002042 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002043 }
2044 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2045 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002046 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002047 }
2048 return result;
2049}
2050
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002051// Test if two VkExtent3D structs are equivalent
2052static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2053 bool result = true;
2054 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2055 (extent->depth != other_extent->depth)) {
2056 result = false;
2057 }
2058 return result;
2059}
2060
Dave Houltonee281a52017-12-08 13:51:02 -07002061// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
2062// Destination image texel extents must be adjusted by block size for the dest validation checks
2063VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
2064 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06002065 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2066 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002067 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002068 adjusted_extent.width /= block_size.width;
2069 adjusted_extent.height /= block_size.height;
2070 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06002071 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2072 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002073 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002074 adjusted_extent.width *= block_size.width;
2075 adjusted_extent.height *= block_size.height;
2076 adjusted_extent.depth *= block_size.depth;
2077 }
2078 return adjusted_extent;
2079}
2080
Dave Houlton6f9059e2017-05-02 17:15:13 -06002081// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002082static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2083 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002084
2085 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002086 if (mip >= img->createInfo.mipLevels) {
2087 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002088 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002089
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002090 // 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 -06002091 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002092
Dave Houltone48cd112019-01-03 17:01:18 -07002093 // If multi-plane, adjust per-plane extent
2094 if (FormatIsMultiplane(img->createInfo.format)) {
2095 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2096 extent.width /= divisors.width;
2097 extent.height /= divisors.height;
2098 }
2099
Jeff Bolzef40fec2018-09-01 22:04:34 -05002100 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2101 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002102 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002103 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2104 } else {
2105 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2106 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2107 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2108 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002109
Dave Houlton6f9059e2017-05-02 17:15:13 -06002110 // Image arrays have an effective z extent that isn't diminished by mip level
2111 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002112 extent.depth = img->createInfo.arrayLayers;
2113 }
2114
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002115 return extent;
2116}
2117
2118// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002119static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002120 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2121}
2122
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002123// Test if the extent argument has any dimensions set to 0.
2124static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2125 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2126}
2127
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002128// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002129VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002130 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2131 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002132 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002133 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002134 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002135 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002136 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002137 granularity.width *= block_size.width;
2138 granularity.height *= block_size.height;
2139 }
2140 }
2141 return granularity;
2142}
2143
2144// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2145static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2146 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002147 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2148 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002149 valid = false;
2150 }
2151 return valid;
2152}
2153
2154// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002155bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002156 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002157 bool skip = false;
2158 VkExtent3D offset_extent = {};
2159 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2160 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2161 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002162 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002163 // 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 -07002164 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002165 skip |= LogError(cb_node->commandBuffer, vuid,
2166 "%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 "
2167 "image transfer granularity is (w=0, h=0, d=0).",
2168 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002169 }
2170 } else {
2171 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2172 // integer multiples of the image transfer granularity.
2173 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002174 skip |= LogError(cb_node->commandBuffer, vuid,
2175 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2176 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2177 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2178 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002179 }
2180 }
2181 return skip;
2182}
2183
2184// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002185bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002186 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002187 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002188 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002189 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002190 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2191 // subresource extent.
2192 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002193 skip |= LogError(cb_node->commandBuffer, vuid,
2194 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2195 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2196 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2197 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002198 }
2199 } else {
2200 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2201 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2202 // subresource extent dimensions.
2203 VkExtent3D offset_extent_sum = {};
2204 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2205 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2206 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002207 bool x_ok = true;
2208 bool y_ok = true;
2209 bool z_ok = true;
2210 switch (image_type) {
2211 case VK_IMAGE_TYPE_3D:
2212 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2213 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002214 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002215 case VK_IMAGE_TYPE_2D:
2216 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2217 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002218 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002219 case VK_IMAGE_TYPE_1D:
2220 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2221 (subresource_extent->width == offset_extent_sum.width));
2222 break;
2223 default:
2224 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2225 assert(false);
2226 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002227 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002228 skip |=
2229 LogError(cb_node->commandBuffer, vuid,
2230 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2231 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2232 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2233 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2234 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2235 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002236 }
2237 }
2238 return skip;
2239}
2240
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002241bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002242 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002243 bool skip = false;
2244 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002245 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2246 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002247 }
2248 return skip;
2249}
2250
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002251bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002252 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002253 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002254 bool skip = false;
2255 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2256 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002257 skip |= LogError(cb_node->commandBuffer, vuid,
2258 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2259 "%u, but provided %s has %u array layers.",
2260 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2261 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002262 }
2263 return skip;
2264}
2265
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002266// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002267bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002268 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002269 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002270 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002271 VkExtent3D granularity = GetScaledItg(cb_node, img);
2272 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002273 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002274 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002275 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002276 return skip;
2277}
2278
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002279// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002280bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002281 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002282 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002283 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002284 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002285 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2286 skip |=
2287 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002288 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002289 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002290 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2291 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002292
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002293 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002294 granularity = GetScaledItg(cb_node, dst_img);
2295 skip |=
2296 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002297 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002298 const VkExtent3D dest_effective_extent =
2299 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002300 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002301 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002302 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002303 return skip;
2304}
2305
Dave Houlton6f9059e2017-05-02 17:15:13 -06002306// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002307bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002308 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002309 bool skip = false;
2310
2311 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002312 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002313
2314 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002315 const VkExtent3D src_copy_extent = region.extent;
2316 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002317 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2318
Dave Houlton6f9059e2017-05-02 17:15:13 -06002319 bool slice_override = false;
2320 uint32_t depth_slices = 0;
2321
2322 // Special case for copying between a 1D/2D array and a 3D image
2323 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2324 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002325 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002326 slice_override = (depth_slices != 1);
2327 } 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 -07002328 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002329 slice_override = (depth_slices != 1);
2330 }
2331
2332 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002333 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002334 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002335 skip |=
2336 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2337 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2338 "be 0 and 1, respectively.",
2339 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002340 }
2341 }
2342
Dave Houlton533be9f2018-03-26 17:08:30 -06002343 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 -07002344 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2345 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2346 "these must be 0 and 1, respectively.",
2347 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002348 }
2349
Dave Houlton533be9f2018-03-26 17:08:30 -06002350 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002351 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2352 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2353 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002354 }
2355
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002356 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002357 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002358 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002359 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002360 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2361 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2362 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2363 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002364 }
2365 }
2366 } else { // Pre maint 1
2367 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002368 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002369 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2370 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2371 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2372 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2373 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002374 }
2375 }
2376 }
2377
Dave Houltonc991cc92018-03-06 11:08:51 -07002378 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002379 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002380 if (FormatIsCompressed(src_state->createInfo.format) ||
2381 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002382 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002383 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002384 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2385 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2386 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002387 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002388 skip |= LogError(src_state->image, vuid,
2389 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2390 "texel width & height (%d, %d).",
2391 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002392 }
2393
Dave Houlton94a00372017-12-14 15:08:47 -07002394 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002395 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2396 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002397 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002398 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002399 LogError(src_state->image, vuid,
2400 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2401 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2402 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002403 }
2404
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002405 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002406 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2407 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002408 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002409 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002410 LogError(src_state->image, vuid,
2411 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2412 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2413 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002414 }
2415
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002416 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002417 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2418 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002419 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002420 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002421 LogError(src_state->image, vuid,
2422 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2423 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2424 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002425 }
2426 } // Compressed
2427
2428 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002429 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002430 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002431 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2432 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2433 "these must be 0 and 1, respectively.",
2434 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002435 }
2436 }
2437
Dave Houlton533be9f2018-03-26 17:08:30 -06002438 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 -07002439 skip |=
2440 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2441 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2442 "and 1, respectively.",
2443 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002444 }
2445
Dave Houlton533be9f2018-03-26 17:08:30 -06002446 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002447 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2448 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2449 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002450 }
2451
2452 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002453 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002454 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2455 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2456 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2457 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002458 }
2459 }
2460 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002461 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002462 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002463 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002464 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002465 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2466 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2467 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2468 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002469 }
2470 }
2471 } else { // Pre maint 1
2472 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002473 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002474 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2475 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2476 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2477 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2478 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002479 }
2480 }
2481 }
2482
Dave Houltonc991cc92018-03-06 11:08:51 -07002483 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2484 if (FormatIsCompressed(dst_state->createInfo.format) ||
2485 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002486 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002487
2488 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002489 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2490 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2491 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002492 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002493 skip |= LogError(dst_state->image, vuid,
2494 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2495 "texel width & height (%d, %d).",
2496 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002497 }
2498
Dave Houlton94a00372017-12-14 15:08:47 -07002499 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002500 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2501 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002502 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002503 skip |= LogError(
2504 dst_state->image, vuid,
2505 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2506 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2507 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002508 }
2509
Dave Houltonee281a52017-12-08 13:51:02 -07002510 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2511 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2512 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002513 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002514 skip |= LogError(dst_state->image, vuid,
2515 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2516 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2517 "height (%d).",
2518 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002519 }
2520
Dave Houltonee281a52017-12-08 13:51:02 -07002521 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2522 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2523 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002524 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002525 skip |= LogError(
2526 dst_state->image, vuid,
2527 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2528 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2529 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002530 }
2531 } // Compressed
2532 }
2533 return skip;
2534}
2535
Dave Houltonc991cc92018-03-06 11:08:51 -07002536// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002537bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002538 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002539 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002540
2541 // Neither image is multiplane
2542 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2543 // If neither image is multi-plane the aspectMask member of src and dst must match
2544 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2545 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002546 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002547 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002548 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002549 }
2550 } else {
2551 // Source image multiplane checks
2552 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2553 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2554 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2555 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002556 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002557 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002558 }
2559 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2560 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2561 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002562 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002563 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002564 }
2565 // Single-plane to multi-plane
2566 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2567 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2568 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002569 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002570 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002571 }
2572
2573 // Dest image multiplane checks
2574 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2575 aspect = region.dstSubresource.aspectMask;
2576 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2577 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002578 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002579 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002580 }
2581 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2582 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2583 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002584 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002585 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002586 }
2587 // Multi-plane to single-plane
2588 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2589 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2590 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002591 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002592 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002593 }
2594 }
2595
2596 return skip;
2597}
2598
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002599bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2600 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002601 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002602 const auto *cb_node = GetCBState(commandBuffer);
2603 const auto *src_image_state = GetImageState(srcImage);
2604 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002605 const VkFormat src_format = src_image_state->createInfo.format;
2606 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002607 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002608
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002609 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002610
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002611 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2612
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002613 for (uint32_t i = 0; i < regionCount; i++) {
2614 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002615
2616 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2617 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002618 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002619
Dave Houlton6f9059e2017-05-02 17:15:13 -06002620 bool slice_override = false;
2621 uint32_t depth_slices = 0;
2622
2623 // Special case for copying between a 1D/2D array and a 3D image
2624 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2625 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2626 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002627 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002628 slice_override = (depth_slices != 1);
2629 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2630 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002631 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002632 slice_override = (depth_slices != 1);
2633 }
2634
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002635 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2636 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2637 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002638 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002639 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002640 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002641 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002642 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2643 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002644 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002645 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2646 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002647
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002648 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002649 // No chance of mismatch if we're overriding depth slice count
2650 if (!slice_override) {
2651 // The number of depth slices in srcSubresource and dstSubresource must match
2652 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2653 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002654 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2655 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002656 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002657 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2658 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002659 if (src_slices != dst_slices) {
2660 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002661 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002662 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002663 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002664 }
2665 }
2666 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002667 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002668 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002669 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002670 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002671 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002672 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002673 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002674 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002675
Dave Houltonc991cc92018-03-06 11:08:51 -07002676 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002677 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002678 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002679 }
2680
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002681 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002682 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2683 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002684 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002685 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002686 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002687 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002688
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002689 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002690 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002691 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002692 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002693 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002694 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002695 }
2696
2697 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002698 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002699 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002700 ss << "vkCmdCopyImage(): pRegion[" << i
2701 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002702 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002703 }
2704
Dave Houltonfc1a4052017-04-27 14:32:45 -06002705 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002706 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2707 if (slice_override) src_copy_extent.depth = depth_slices;
2708 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002709 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002710 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002711 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2712 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2713 "width [%1d].",
2714 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002715 }
2716
2717 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002718 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002719 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2720 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2721 "height [%1d].",
2722 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002723 }
2724 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002725 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002726 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2727 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2728 "depth [%1d].",
2729 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002730 }
2731
Dave Houltonee281a52017-12-08 13:51:02 -07002732 // Adjust dest extent if necessary
2733 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2734 if (slice_override) dst_copy_extent.depth = depth_slices;
2735
2736 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002737 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002738 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2739 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2740 "width [%1d].",
2741 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002742 }
2743 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002744 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2745 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2746 "height [%1d].",
2747 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002748 }
2749 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002750 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2751 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2752 "depth [%1d].",
2753 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002754 }
2755
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002756 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2757 // must not overlap in memory
2758 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002759 for (uint32_t j = 0; j < regionCount; j++) {
2760 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002761 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002762 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002763 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002764 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002765 }
2766 }
2767 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002768
2769 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2770 if (device_extensions.vk_khr_maintenance1) {
2771 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2772 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2773 (src_copy_extent.depth != 1)) {
2774 skip |= LogError(
2775 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2776 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2777 src_copy_extent.depth);
2778 }
2779 } else {
2780 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2781 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2782 (src_copy_extent.depth != 1)) {
2783 skip |= LogError(
2784 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2785 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2786 src_copy_extent.depth);
2787 }
2788 }
2789
2790 // Check if 2D with 3D and depth not equal to 2D layerCount
2791 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2792 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2793 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2794 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2795 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2796 "srcSubresource.layerCount (%u)",
2797 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2798 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2799 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2800 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2801 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2802 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2803 "dstSubresource.layerCount (%u)",
2804 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2805 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002806
2807 // Check for multi-plane format compatiblity
2808 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
2809 size_t src_format_size = 0;
2810 size_t dst_format_size = 0;
2811 if (FormatIsMultiplane(src_format)) {
2812 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
2813 src_format_size = FormatElementSize(planeFormat);
2814 } else {
2815 src_format_size = FormatElementSize(src_format);
2816 }
2817 if (FormatIsMultiplane(dst_format)) {
2818 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
2819 dst_format_size = FormatElementSize(planeFormat);
2820 } else {
2821 dst_format_size = FormatElementSize(dst_format);
2822 }
2823 // If size is still zero, then format is invalid and will be caught in another VU
2824 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
2825 skip |=
2826 LogError(command_buffer, "VUID-vkCmdCopyImage-None-01549",
2827 "vkCmdCopyImage(): pRegions[%u] called with non-compatible image formats. "
2828 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
2829 i, string_VkFormat(src_format), string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(),
2830 string_VkFormat(dst_format), string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
2831 }
2832 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002833 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002834
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002835 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
2836 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
2837 // because because both texels are 4 bytes in size.
2838 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
2839 const char *compatible_vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2840 : "VUID-vkCmdCopyImage-srcImage-00135";
2841 // Depth/stencil formats must match exactly.
2842 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2843 if (src_format != dst_format) {
2844 skip |= LogError(command_buffer, compatible_vuid,
2845 "vkCmdCopyImage(): Depth/stencil formats must match exactly for src (%s) and dst (%s).",
2846 string_VkFormat(src_format), string_VkFormat(dst_format));
2847 }
2848 } else {
2849 if (!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) {
2850 skip |= LogError(command_buffer, compatible_vuid,
2851 "vkCmdCopyImage(): Unmatched image format sizes. "
2852 "The src format %s has size of %zu and dst format %s has size of %zu.",
2853 string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
2854 FormatElementSize(dst_format));
2855 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002856 }
2857 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002858
Dave Houlton33c22b72017-02-28 13:16:02 -07002859 // Source and dest image sample counts must match
2860 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2861 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002862 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002863 }
2864
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002865 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2866 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002867 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002868 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2869 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2870 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2871 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002872 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002873 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002874 "VUID-vkCmdCopyImage-srcImage-01995");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002875 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002876 "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002877 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002878 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002879 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002880 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2881 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002882 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002883 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2884 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2885 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2886 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2887 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2888 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002889 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002890 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002891 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2892 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002893 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002894 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2895 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002896 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2897 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002898 }
2899
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002900 return skip;
2901}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002902
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002903void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2904 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2905 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002906 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2907 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002908 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002909 auto src_image_state = GetImageState(srcImage);
2910 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002911
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002912 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002913 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002914 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2915 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002916 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002917}
2918
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002919// Returns true if sub_rect is entirely contained within rect
2920static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2921 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2922 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2923 return false;
2924 return true;
2925}
2926
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002927bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002928 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2929 const VkRect2D &render_area, uint32_t rect_count,
2930 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002931 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002932 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2933 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06002934 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07002935 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002936
2937 for (uint32_t j = 0; j < rect_count; j++) {
2938 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002939 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2940 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2941 "the current render pass instance.",
2942 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002943 }
2944
2945 if (image_view_state) {
2946 // The layers specified by a given element of pRects must be contained within every attachment that
2947 // pAttachments refers to
2948 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2949 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2950 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002951 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2952 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2953 "of pAttachment[%d].",
2954 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002955 }
2956 }
2957 }
2958 return skip;
2959}
2960
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002961bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2962 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002963 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002964 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002965 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002966 if (!cb_node) return skip;
2967
2968 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2969 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2970 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002971 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002972
2973 // Validate that attachment is in reference list of active subpass
2974 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002975 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002976 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002977 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002978 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002979 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002980
John Zulauf3a548ef2019-02-01 16:14:07 -07002981 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2982 auto clear_desc = &pAttachments[attachment_index];
2983 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002984
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002985 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002986 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002987 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002988 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002989 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002990 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2991 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2992 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2993 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002994 skip |= LogError(
2995 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2996 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2997 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2998 attachment_index, clear_desc->colorAttachment,
2999 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3000 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003001
John Zulauff2582972019-02-09 14:53:30 -07003002 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3003 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003004 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003005 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3006 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3007 " subpass %u. colorAttachmentCount=%u",
3008 attachment_index, clear_desc->colorAttachment,
3009 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3010 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003011 }
John Zulauff2582972019-02-09 14:53:30 -07003012 fb_attachment = color_attachment;
3013
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003014 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3015 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3016 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003017 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003018 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003019 }
3020 } else { // Must be depth and/or stencil
3021 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
3022 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003023 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003024 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003025 }
3026 if (!subpass_desc->pDepthStencilAttachment ||
3027 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003028 skip |= LogPerformanceWarning(
3029 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003030 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003031 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003032 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003033 }
3034 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003035 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003036 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3037 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003038 }
3039 }
3040 }
3041 return skip;
3042}
3043
3044void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3045 const VkClearAttachment *pAttachments, uint32_t rectCount,
3046 const VkClearRect *pRects) {
3047 auto *cb_node = GetCBState(commandBuffer);
3048 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3049 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3050 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3051 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3052 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3053 const auto clear_desc = &pAttachments[attachment_index];
3054 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3055 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3056 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3057 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3058 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3059 subpass_desc->pDepthStencilAttachment) {
3060 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3061 }
3062 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003063 if (!clear_rect_copy) {
3064 // We need a copy of the clear rectangles that will persist until the last lambda executes
3065 // but we want to create it as lazily as possible
3066 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003067 }
John Zulauf441558b2019-08-12 11:47:39 -06003068 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3069 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003070 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003071 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003072 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003073 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003074 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3075 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003076 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3077 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003078 return skip;
3079 };
3080 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003081 }
3082 }
3083 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003084}
3085
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003086bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3087 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003088 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003089 const auto *cb_node = GetCBState(commandBuffer);
3090 const auto *src_image_state = GetImageState(srcImage);
3091 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003092
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003093 bool skip = false;
3094 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003095 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3096 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003097 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003098 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003099 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3100 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003101 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003102 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003103
Cort Stratton7df30962018-05-17 19:45:57 -07003104 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003105 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003106 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003107 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3108 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3109 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003110 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003111 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3112 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003113 // For each region, the number of layers in the image subresource should not be zero
3114 // For each region, src and dest image aspect must be color only
3115 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003116 skip |=
3117 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3118 skip |=
3119 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003120 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003121 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3122 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003123 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003124 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3125 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003126 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3127 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3128 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3129 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3130 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003131 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3132 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003133 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003134 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3135 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003136
3137 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003138 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003139 skip |= LogError(
3140 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003141 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003142 }
Cort Stratton7df30962018-05-17 19:45:57 -07003143 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003144 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3145 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3146 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003147 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003148 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003149 }
3150 }
3151
3152 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3153 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003154 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003155 }
3156 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3157 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003158 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003159 }
3160 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3161 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003162 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003163 }
3164 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3165 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003166 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003167 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003168 } else {
3169 assert(0);
3170 }
3171 return skip;
3172}
3173
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003174bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3175 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003176 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003177 const auto *cb_node = GetCBState(commandBuffer);
3178 const auto *src_image_state = GetImageState(srcImage);
3179 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003180
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003181 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003182 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003183 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003184 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003185 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003186 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003187 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003188 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003189 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003190 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3191 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003192 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003193 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3194 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003195 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003196 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3197 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003198 skip |=
3199 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003200 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3201 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003202 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003203 "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003204 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003205 "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003206
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003207 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003208
Dave Houlton33c2d252017-06-09 17:08:32 -06003209 VkFormat src_format = src_image_state->createInfo.format;
3210 VkFormat dst_format = dst_image_state->createInfo.format;
3211 VkImageType src_type = src_image_state->createInfo.imageType;
3212 VkImageType dst_type = dst_image_state->createInfo.imageType;
3213
Cort Stratton186b1a22018-05-01 20:18:06 -04003214 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003215 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003216 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003217 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003218 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003219 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003220 }
3221
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003222 if (FormatRequiresYcbcrConversion(src_format)) {
3223 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3224 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3225 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3226 string_VkFormat(src_format));
3227 }
3228
3229 if (FormatRequiresYcbcrConversion(dst_format)) {
3230 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3231 "vkCmdBlitImage(): dstImage 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(dst_format));
3234 }
3235
Dave Houlton33c2d252017-06-09 17:08:32 -06003236 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003237 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3238 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003239 }
3240
Dave Houlton33c2d252017-06-09 17:08:32 -06003241 // Validate consistency for unsigned formats
3242 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3243 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003244 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003245 << "the other one must also have unsigned integer format. "
3246 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003247 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003248 }
3249
3250 // Validate consistency for signed formats
3251 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3252 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003253 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003254 << "the other one must also have signed integer format. "
3255 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003256 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003257 }
3258
3259 // Validate filter for Depth/Stencil formats
3260 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3261 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003262 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003263 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003264 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003265 }
3266
3267 // Validate aspect bits and formats for depth/stencil images
3268 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3269 if (src_format != dst_format) {
3270 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003271 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003272 << "stencil, the other one must have exactly the same format. "
3273 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3274 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003275 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003276 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003277 } // Depth or Stencil
3278
3279 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003280 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003281 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003282 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3283 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3284 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003285 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003286 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3287 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003288 for (uint32_t i = 0; i < regionCount; i++) {
3289 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003290 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003291 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003292 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3293 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003294 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003295 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3296 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003297 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3298 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3299 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003300 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003301 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003302 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003303 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003304 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3305 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003306 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003307 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3308 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003309 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003310 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3311 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003312 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003313 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003314 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003315 }
Dave Houlton48989f32017-05-26 15:01:46 -06003316 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3317 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003318 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003319 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003320 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003321 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003322
3323 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003324 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003325 skip |= LogError(
3326 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003327 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003328 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003329
Dave Houlton48989f32017-05-26 15:01:46 -06003330 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003331 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3332 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003333 }
Dave Houlton48989f32017-05-26 15:01:46 -06003334
Dave Houlton33c2d252017-06-09 17:08:32 -06003335 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003336 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3337 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3338 "image format %s.",
3339 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003340 }
3341
3342 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003343 skip |= LogError(
3344 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003345 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3346 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003347 }
3348
Dave Houlton48989f32017-05-26 15:01:46 -06003349 // Validate source image offsets
3350 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003351 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003352 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003353 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003354 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3355 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3356 "of (%1d, %1d). These must be (0, 1).",
3357 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003358 }
3359 }
3360
Dave Houlton33c2d252017-06-09 17:08:32 -06003361 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003362 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003363 skip |=
3364 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3365 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3366 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3367 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003368 }
3369 }
3370
Dave Houlton33c2d252017-06-09 17:08:32 -06003371 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003372 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3373 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003374 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003375 skip |= LogError(
3376 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003377 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3378 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003379 }
3380 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3381 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003382 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003383 skip |= LogError(
3384 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003385 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003386 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003387 }
3388 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3389 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003390 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003391 skip |= LogError(
3392 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003393 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3394 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003395 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003396 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003397 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3398 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003399 }
Dave Houlton48989f32017-05-26 15:01:46 -06003400
3401 // Validate dest image offsets
3402 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003403 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003404 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003405 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003406 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3407 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3408 "(%1d, %1d). These must be (0, 1).",
3409 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003410 }
3411 }
3412
Dave Houlton33c2d252017-06-09 17:08:32 -06003413 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003414 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003415 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3416 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3417 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3418 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003419 }
3420 }
3421
Dave Houlton33c2d252017-06-09 17:08:32 -06003422 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003423 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3424 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003425 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003426 skip |= LogError(
3427 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003428 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3429 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003430 }
3431 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3432 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003433 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003434 skip |= LogError(
3435 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003436 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003437 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003438 }
3439 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3440 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003441 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003442 skip |= LogError(
3443 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003444 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3445 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003446 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003447 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003448 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3449 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003450 }
3451
Dave Houlton33c2d252017-06-09 17:08:32 -06003452 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3453 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3454 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003455 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003456 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3457 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3458 "layerCount other than 1.",
3459 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003460 }
3461 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003462 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003463 } else {
3464 assert(0);
3465 }
3466 return skip;
3467}
3468
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003469void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3470 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3471 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003472 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3473 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003474 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003475 auto src_image_state = GetImageState(srcImage);
3476 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003477
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003478 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003479 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003480 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3481 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003482 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003483}
3484
John Zulauf2076e812020-01-08 14:55:54 -07003485GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3486 assert(map);
3487 // This approach allows for a single hash lookup or/create new
3488 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3489 if (inserted.second) {
3490 assert(nullptr == inserted.first->second.get());
3491 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.range_encoder.SubresourceCount());
3492 inserted.first->second.reset(layout_map);
3493 return layout_map;
3494 } else {
3495 assert(nullptr != inserted.first->second.get());
3496 return inserted.first->second.get();
3497 }
3498 return nullptr;
3499}
3500
3501const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3502 auto it = map.find(image);
3503 if (it != map.end()) {
3504 return it->second.get();
3505 }
3506 return nullptr;
3507}
3508
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003509// 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 -07003510bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3511 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003512 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003513 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003514 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003515 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003516 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003517 for (const auto &layout_map_entry : pCB->image_layout_map) {
3518 const auto image = layout_map_entry.first;
3519 const auto *image_state = GetImageState(image);
3520 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003521 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003522 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003523 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003524 if (initial_layout_map.empty()) continue;
3525
3526 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3527 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3528 if (global_map == nullptr) {
3529 global_map = &empty_map;
3530 }
3531
3532 // Note: don't know if it would matter
3533 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3534
3535 auto pos = initial_layout_map.begin();
3536 const auto end = initial_layout_map.end();
3537 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3538 pos->first.begin);
3539 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003540 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003541 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003542 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 -07003543 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003544 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003545 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003546 image_layout = current_layout->pos_B->lower_bound->second;
3547 }
3548 const auto intersected_range = pos->first & current_layout->range;
3549 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3550 // TODO: Set memory invalid which is in mem_tracker currently
3551 } else if (image_layout != initial_layout) {
3552 // Need to look up the inital layout *state* to get a bit more information
3553 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3554 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3555 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3556 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07003557 // We can report all the errors for the intersected range directly
3558 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
3559 const auto subresource = image_state->range_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003560 skip |= LogError(
3561 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003562 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003563 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07003564 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003565 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06003566 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003567 }
3568 }
John Zulauf2076e812020-01-08 14:55:54 -07003569 if (pos->first.includes(intersected_range.end)) {
3570 current_layout.seek(intersected_range.end);
3571 } else {
3572 ++pos;
3573 if (pos != end) {
3574 current_layout.seek(pos->first.begin);
3575 }
3576 }
John Zulauff660ad62019-03-23 07:16:05 -06003577 }
3578
locke-lunargf155ccf2020-02-18 11:34:15 -07003579 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003580 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003581 }
John Zulauff660ad62019-03-23 07:16:05 -06003582
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003583 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003584}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003585
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003586void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003587 for (const auto &layout_map_entry : pCB->image_layout_map) {
3588 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003589 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003590 const auto *image_state = GetImageState(image);
3591 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003592 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3593 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003594 }
3595}
3596
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003597// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003598// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3599// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003600bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3601 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003602 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003603 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003604 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3605
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003606 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07003607 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
3608 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003609 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003610 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3611 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3612 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003613 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
3614 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3615 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07003616 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3617 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
3618 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
3619 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3620 string_VkImageLayout(first_layout));
3621 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3622 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003623 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3624 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3625 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003626 }
3627 }
sfricke-samsung55f01952020-03-24 08:16:41 -07003628
3629 // Same as above for loadOp, but for stencilLoadOp
3630 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3631 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3632 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3633 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
3634 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
3635 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3636 string_VkImageLayout(first_layout));
3637 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3638 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
3639 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
3640 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3641 string_VkImageLayout(first_layout));
3642 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3643 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3644 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
3645 "Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003646 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003647 }
3648 }
3649
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003650 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003651}
3652
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003653bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3654 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003655 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003656 const char *vuid;
3657 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003658
Jason Ekstranda1906302017-12-03 20:16:32 -08003659 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3660 VkFormat format = pCreateInfo->pAttachments[i].format;
3661 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3662 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3663 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003664 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3665 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3666 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3667 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3668 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003669 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003670 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003671 skip |=
3672 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3673 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3674 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3675 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3676 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003677 }
3678 }
3679 }
3680
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003681 // Track when we're observing the first use of an attachment
3682 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3683 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003684 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003685
3686 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3687 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3688 auto attach_index = subpass.pInputAttachments[j].attachment;
3689 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003690 switch (subpass.pInputAttachments[j].layout) {
3691 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3692 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3693 // These are ideal.
3694 break;
3695
3696 case VK_IMAGE_LAYOUT_GENERAL:
3697 // May not be optimal. TODO: reconsider this warning based on other constraints.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003698 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3699 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
Cort Stratton7547f772017-05-04 15:18:52 -07003700 break;
3701
Tobias Hectorbbb12282018-10-22 15:17:59 +01003702 case VK_IMAGE_LAYOUT_UNDEFINED:
3703 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003704 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003705 skip |= LogError(device, vuid,
3706 "Layout for input attachment reference %u in subpass %u is %s but must be "
3707 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3708 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003709 break;
3710
Piers Daniell9af77cd2019-10-16 13:54:12 -06003711 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3712 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3713 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3714 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003715 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003716 skip |= LogError(
3717 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003718 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3719 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3720 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3721 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3722 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003723 skip |= LogError(
3724 device, "VUID-VkAttachmentReference2-attachment-03314",
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 &
3730 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3731 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3732 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3733 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3734 const auto *attachment_reference_stencil_layout =
3735 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3736 if (attachment_reference_stencil_layout) {
3737 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3738 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3739 attachment_reference_stencil_layout->stencilLayout ==
3740 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3741 attachment_reference_stencil_layout->stencilLayout ==
3742 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3743 attachment_reference_stencil_layout->stencilLayout ==
3744 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3745 attachment_reference_stencil_layout->stencilLayout ==
3746 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3747 attachment_reference_stencil_layout->stencilLayout ==
3748 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3749 attachment_reference_stencil_layout->stencilLayout ==
3750 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3751 attachment_reference_stencil_layout->stencilLayout ==
3752 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3753 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003754 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3755 "In the attachment reference %u in subpass %u with pNext chain instance "
3756 "VkAttachmentReferenceStencilLayoutKHR"
3757 "the stencilLayout member but must not be "
3758 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3759 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3760 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3761 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3762 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3763 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3764 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3765 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3766 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3767 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003768 }
3769 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003770 skip |= LogError(
3771 device, "VUID-VkAttachmentReference2-attachment-03315",
3772 "When the layout for input attachment reference %u in subpass %u is "
3773 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3774 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3775 "VkAttachmentReferenceStencilLayout instance.",
3776 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003777 }
3778 }
3779 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3780 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3781 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003782 skip |= LogError(
3783 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003784 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3785 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3786 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3787 j, i);
3788 }
3789 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3790 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3791 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003792 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3793 "When the aspectMask for input attachment reference %u in subpass %u is "
3794 "VK_IMAGE_ASPECT_STENCIL_BIT "
3795 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3796 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3797 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003798 }
3799 }
3800 break;
3801
Graeme Leese668a9862018-10-08 10:40:02 +01003802 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3803 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003804 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003805 break;
3806 } else {
3807 // Intentionally fall through to generic error message
3808 }
3809 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003810
Cort Stratton7547f772017-05-04 15:18:52 -07003811 default:
3812 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003813 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3814 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3815 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003816 }
3817
Cort Stratton7547f772017-05-04 15:18:52 -07003818 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003819 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3820 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003821
3822 bool used_as_depth =
3823 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3824 bool used_as_color = false;
3825 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3826 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3827 }
3828 if (!used_as_depth && !used_as_color &&
3829 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003830 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003831 skip |= LogError(device, vuid,
3832 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3833 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003834 }
3835 }
3836 attach_first_use[attach_index] = false;
3837 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003838
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003839 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3840 auto attach_index = subpass.pColorAttachments[j].attachment;
3841 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3842
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003843 // TODO: Need a way to validate shared presentable images here, currently just allowing
3844 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3845 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003846 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003847 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003848 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003849 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3850 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003851 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003852
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003853 case VK_IMAGE_LAYOUT_GENERAL:
3854 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003855 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3856 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003857 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003858
Tobias Hectorbbb12282018-10-22 15:17:59 +01003859 case VK_IMAGE_LAYOUT_UNDEFINED:
3860 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003861 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003862 skip |= LogError(device, vuid,
3863 "Layout for color attachment reference %u in subpass %u is %s but should be "
3864 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3865 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003866 break;
3867
Piers Daniell9af77cd2019-10-16 13:54:12 -06003868 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3869 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3870 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3871 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003872 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003873 skip |= LogError(
3874 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003875 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3876 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3877 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3878 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3879 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003880 skip |= LogError(
3881 device, "VUID-VkAttachmentReference2-attachment-03314",
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 &
3887 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3888 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3889 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3890 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3891 const auto *attachment_reference_stencil_layout =
3892 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3893 if (attachment_reference_stencil_layout) {
3894 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3895 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3896 attachment_reference_stencil_layout->stencilLayout ==
3897 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3898 attachment_reference_stencil_layout->stencilLayout ==
3899 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3900 attachment_reference_stencil_layout->stencilLayout ==
3901 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3902 attachment_reference_stencil_layout->stencilLayout ==
3903 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3904 attachment_reference_stencil_layout->stencilLayout ==
3905 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3906 attachment_reference_stencil_layout->stencilLayout ==
3907 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3908 attachment_reference_stencil_layout->stencilLayout ==
3909 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3910 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003911 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3912 "In the attachment reference %u in subpass %u with pNext chain instance "
3913 "VkAttachmentReferenceStencilLayoutKHR"
3914 "the stencilLayout member but must not be "
3915 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3916 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3917 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3918 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3919 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3920 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3921 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3922 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3923 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3924 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003925 }
3926 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003927 skip |= LogError(
3928 device, "VUID-VkAttachmentReference2-attachment-03315",
3929 "When the layout for color attachment reference %u in subpass %u is "
3930 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3931 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3932 "VkAttachmentReferenceStencilLayout instance.",
3933 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003934 }
3935 }
3936 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3937 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3938 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003939 skip |= LogError(
3940 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003941 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3942 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3943 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3944 j, i);
3945 }
3946 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3947 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3948 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003949 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3950 "When the aspectMask for color attachment reference %u in subpass %u is "
3951 "VK_IMAGE_ASPECT_STENCIL_BIT "
3952 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3953 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3954 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003955 }
3956 }
3957 break;
3958
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003959 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003960 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3961 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3962 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003963 }
3964
John Zulauf4eee2692019-02-09 16:14:25 -07003965 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3966 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3967 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003968 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003969 skip |= LogError(device, vuid,
3970 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
3971 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3972 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003973 }
3974
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003975 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003976 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3977 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003978 }
3979 attach_first_use[attach_index] = false;
3980 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003981
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003982 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3983 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003984 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3985 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3986 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003987 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003988
Dave Houltona9df0ce2018-02-07 10:51:23 -07003989 case VK_IMAGE_LAYOUT_GENERAL:
3990 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3991 // doing a bunch of transitions.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003992 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3993 "GENERAL layout for depth attachment may not give optimal performance.");
Dave Houltona9df0ce2018-02-07 10:51:23 -07003994 break;
3995
Tobias Hectorbbb12282018-10-22 15:17:59 +01003996 case VK_IMAGE_LAYOUT_UNDEFINED:
3997 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003998 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003999 skip |= LogError(device, vuid,
4000 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
4001 "layout or GENERAL.",
4002 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004003 break;
4004
Piers Daniell9af77cd2019-10-16 13:54:12 -06004005 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4006 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4007 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4008 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004009 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004010 skip |= LogError(
4011 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004012 "Layout for depth attachment reference in subpass %u is %s but must not be "
4013 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4014 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4015 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
4016 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004017 skip |= LogError(
4018 device, "VUID-VkAttachmentReference2-attachment-03314",
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 &
4024 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4025 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4026 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4027 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4028 const auto *attachment_reference_stencil_layout =
4029 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
4030 if (attachment_reference_stencil_layout) {
4031 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4032 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4033 attachment_reference_stencil_layout->stencilLayout ==
4034 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4035 attachment_reference_stencil_layout->stencilLayout ==
4036 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4037 attachment_reference_stencil_layout->stencilLayout ==
4038 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4039 attachment_reference_stencil_layout->stencilLayout ==
4040 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4041 attachment_reference_stencil_layout->stencilLayout ==
4042 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4043 attachment_reference_stencil_layout->stencilLayout ==
4044 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4045 attachment_reference_stencil_layout->stencilLayout ==
4046 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4047 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004048 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
4049 "In the attachment reference in subpass %u with pNext chain instance "
4050 "VkAttachmentReferenceStencilLayoutKHR"
4051 "the stencilLayout member but must not be "
4052 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4053 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4054 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4055 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4056 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4057 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4058 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4059 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4060 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
4061 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004062 }
4063 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004064 skip |= LogError(
4065 device, "VUID-VkAttachmentReference2-attachment-03315",
4066 "When the layout for depth attachment reference in subpass %u is "
4067 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4068 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4069 "VkAttachmentReferenceStencilLayout instance.",
4070 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004071 }
4072 }
4073 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4074 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4075 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004076 skip |= LogError(
4077 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004078 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
4079 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4080 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4081 i);
4082 }
4083 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4084 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4085 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004086 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
4087 "When the aspectMask for depth attachment reference in subpass %u is "
4088 "VK_IMAGE_ASPECT_STENCIL_BIT "
4089 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4090 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
4091 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004092 }
4093 }
4094 break;
4095
Dave Houltona9df0ce2018-02-07 10:51:23 -07004096 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4097 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004098 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004099 break;
4100 } else {
4101 // Intentionally fall through to generic error message
4102 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004103 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004104
Dave Houltona9df0ce2018-02-07 10:51:23 -07004105 default:
4106 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004107 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
4108 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4109 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
4110 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004111 }
4112
4113 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4114 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004115 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4116 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004117 }
4118 attach_first_use[attach_index] = false;
4119 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004120 }
4121 return skip;
4122}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004123
Mark Lobodzinski96210742017-02-09 10:33:46 -07004124// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4125// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004126template <typename T1>
4127bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4128 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4129 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004130 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004131 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004132 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004133 if (strict) {
4134 correct_usage = ((actual & desired) == desired);
4135 } else {
4136 correct_usage = ((actual & desired) != 0);
4137 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004138
Mark Lobodzinski96210742017-02-09 10:33:46 -07004139 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004140 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004141 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004142 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
4143 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4144 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004145 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004146 skip = LogError(object, msgCode,
4147 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4148 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004149 }
4150 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004151 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004152}
4153
4154// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4155// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004156bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004157 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004158 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004159 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004160}
4161
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004162bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004163 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004164 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004165 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4166 if ((image_format_features & desired) != desired) {
4167 // Same error, but more details if it was an AHB external format
4168 if (image_state->has_ahb_format == true) {
4169 skip |= LogError(image_state->image, vuid,
4170 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4171 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4172 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004173 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004174 } else {
4175 skip |= LogError(image_state->image, vuid,
4176 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4177 "with tiling %s.",
4178 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4179 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4180 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004181 }
4182 }
4183 return skip;
4184}
4185
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004186bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004187 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004188 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004189 // layerCount must not be zero
4190 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004191 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4192 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004193 }
4194 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4195 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004196 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4197 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004198 }
4199 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4200 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4201 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004202 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4203 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4204 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4205 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004206 }
4207 return skip;
4208}
4209
Mark Lobodzinski96210742017-02-09 10:33:46 -07004210// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4211// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004212bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004213 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004214 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004215 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004216}
4217
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004218bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004219 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004220 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004221
4222 const VkDeviceSize &range = pCreateInfo->range;
4223 if (range != VK_WHOLE_SIZE) {
4224 // Range must be greater than 0
4225 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004226 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
4227 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4228 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4229 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004230 }
4231 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004232 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4233 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004234 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
4235 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4236 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4237 "(%" PRIu32 ").",
4238 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004239 }
4240 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004241 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004242 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
4243 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4244 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4245 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4246 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004247 }
4248 // The sum of range and offset must be less than or equal to the size of buffer
4249 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004250 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
4251 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4252 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4253 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4254 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004255 }
4256 }
4257 return skip;
4258}
4259
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004260bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004261 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004262 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004263 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4264 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004265 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
4266 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4267 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004268 }
4269 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4270 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004271 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
4272 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4273 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004274 }
4275 return skip;
4276}
4277
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004278bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004279 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004280 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004281
Dave Houltond8ed0212018-05-16 17:18:24 -06004282 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004283
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004284 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004285 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4286 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4287 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004288 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004289
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004290 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004291 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4292 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4293 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004294 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004295
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004296 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004297 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4298 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4299 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004300 }
Jeff Bolz87697532019-01-11 22:54:00 -06004301
4302 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4303 if (chained_devaddr_struct) {
4304 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4305 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004306 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4307 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4308 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004309 }
4310 }
4311
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004312 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4313 if (chained_opaqueaddr_struct) {
4314 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4315 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004316 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4317 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4318 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004319 }
4320 }
4321
Shannon McPherson4984e642019-12-05 13:04:34 -07004322 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004323 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4324 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004325 skip |= LogError(
4326 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004327 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4328 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4329 }
4330
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004331 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004332 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4333 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4334 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004335 }
4336
Mark Lobodzinski96210742017-02-09 10:33:46 -07004337 return skip;
4338}
4339
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004340bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004341 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004342 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004343 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004344 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4345 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004346 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004347 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4348 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004349 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004350 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4351 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4352 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004353
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004354 // Buffer view offset must be less than the size of buffer
4355 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004356 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
4357 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4358 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4359 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004360 }
4361
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004362 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004363 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4364 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4365 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004366 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-02749",
4367 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4368 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4369 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004370 }
4371
4372 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4373 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4374 if ((elementSize % 3) == 0) {
4375 elementSize /= 3;
4376 }
4377 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4378 VkDeviceSize alignmentRequirement =
4379 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4380 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4381 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4382 }
4383 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004384 skip |= LogError(
4385 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004386 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4387 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4388 ") must be a multiple of the lesser of "
4389 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4390 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4391 "(%" PRId32
4392 ") is VK_TRUE, the size of a texel of the requested format. "
4393 "If the size of a texel is a multiple of three bytes, then the size of a "
4394 "single component of format is used instead",
4395 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4396 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4397 }
4398 }
4399 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4400 VkDeviceSize alignmentRequirement =
4401 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4402 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4403 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4404 }
4405 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004406 skip |= LogError(
4407 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004408 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4409 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4410 ") must be a multiple of the lesser of "
4411 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4412 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4413 "(%" PRId32
4414 ") is VK_TRUE, the size of a texel of the requested format. "
4415 "If the size of a texel is a multiple of three bytes, then the size of a "
4416 "single component of format is used instead",
4417 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4418 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4419 }
4420 }
4421 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004422
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004423 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004424
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004425 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004426 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004427 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004428}
4429
Mark Lobodzinski602de982017-02-09 11:01:33 -07004430// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004431bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004432 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004433 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004434 const IMAGE_STATE *image_state = GetImageState(image);
4435 // checks color format and (single-plane or non-disjoint)
4436 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004437 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004438 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004439 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 -07004440 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004441 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 -07004442 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004443 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004444 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004445 skip |= LogError(image, vuid,
4446 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4447 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4448 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004449 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004450 skip |= LogError(image, vuid,
4451 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4452 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4453 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004454 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004455 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004456 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004457 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 -07004458 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004459 skip |=
4460 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 -07004461 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004462 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004463 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004464 skip |=
4465 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 -07004466 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004467 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4468 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004469 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004470 } else if (FormatIsMultiplane(format)) {
4471 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4472 if (3 == FormatPlaneCount(format)) {
4473 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4474 }
4475 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004476 skip |=
4477 LogError(image, vuid,
4478 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4479 "set, where n = [0, 1, 2].",
4480 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004481 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004482 }
4483 return skip;
4484}
4485
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004486bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4487 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004488 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4489 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004490 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004491
4492 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004493 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004494 skip |= LogError(image, errorCodes.base_mip_err,
4495 "%s: %s.baseMipLevel (= %" PRIu32
4496 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4497 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004498 }
Petr Kraus4d718682017-05-18 03:38:41 +02004499
Petr Krausffa94af2017-08-08 21:46:02 +02004500 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4501 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004502 skip |= LogError(image, errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004503 } else {
4504 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004505
Petr Krausffa94af2017-08-08 21:46:02 +02004506 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004507 skip |= LogError(image, errorCodes.mip_count_err,
4508 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4509 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4510 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4511 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004512 }
Petr Kraus4d718682017-05-18 03:38:41 +02004513 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004514 }
Petr Kraus4d718682017-05-18 03:38:41 +02004515
4516 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004517 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004518 skip |= LogError(image, errorCodes.base_layer_err,
4519 "%s: %s.baseArrayLayer (= %" PRIu32
4520 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4521 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004522 }
Petr Kraus4d718682017-05-18 03:38:41 +02004523
Petr Krausffa94af2017-08-08 21:46:02 +02004524 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4525 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004526 skip |= LogError(image, errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004527 } else {
4528 const uint64_t necessary_layer_count =
4529 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004530
Petr Krausffa94af2017-08-08 21:46:02 +02004531 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004532 skip |= LogError(image, errorCodes.layer_count_err,
4533 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4534 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4535 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4536 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004537 }
Petr Kraus4d718682017-05-18 03:38:41 +02004538 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004539 }
Petr Kraus4d718682017-05-18 03:38:41 +02004540
Mark Lobodzinski602de982017-02-09 11:01:33 -07004541 return skip;
4542}
4543
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004544bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004545 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004546 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004547 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4548 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4549 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4550
4551 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4552 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4553
4554 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004555 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4556 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004557 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004558 : "VUID-VkImageViewCreateInfo-image-01482")
4559 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4560 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004561 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004562 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4563 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004564
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004565 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004566 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004567 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004568}
4569
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004570bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004571 const VkImageSubresourceRange &subresourceRange,
4572 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004573 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004574 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4575 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4576 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4577 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004578
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004579 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004580 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004581 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004582}
4583
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004584bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004585 const VkImageSubresourceRange &subresourceRange,
4586 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004587 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004588 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4589 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4590 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4591 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004592
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004593 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004594 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4595 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004596}
4597
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004598bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004599 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004600 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004601 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004602 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4603 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4604 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4605 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004606
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004607 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004608 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004609}
4610
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004611bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4612 const VkImageUsageFlags image_usage) const {
4613 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4614 bool skip = false;
4615
4616 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4617 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4618
4619 if (image_state->has_ahb_format == true) {
4620 // AHB image view and image share same feature sets
4621 tiling_features = image_state->format_features;
4622 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4623 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4624 assert(device_extensions.vk_ext_image_drm_format_modifier);
4625 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4626 nullptr};
4627 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4628
4629 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4630 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4631 nullptr};
4632 format_properties_2.pNext = (void *)&drm_properties_list;
4633 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4634
4635 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4636 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4637 0) {
4638 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4639 }
4640 }
4641 } else {
4642 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4643 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4644 : format_properties.optimalTilingFeatures;
4645 }
4646
4647 if (tiling_features == 0) {
4648 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4649 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4650 "physical device.",
4651 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4652 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4653 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4654 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4655 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4656 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4657 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4658 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4659 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4660 "VK_IMAGE_USAGE_STORAGE_BIT.",
4661 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4662 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4663 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4664 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4665 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4666 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4667 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4668 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4669 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4670 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4671 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4672 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4673 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4674 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4675 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4676 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4677 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4678 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4679 }
4680
4681 return skip;
4682}
4683
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004684bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004685 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004686 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004687 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004688 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004689 skip |=
4690 ValidateImageUsageFlags(image_state,
4691 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4692 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4693 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4694 false, kVUIDUndefined, "vkCreateImageView()",
4695 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4696 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004697 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004698 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004699 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004700 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004701 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004702 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004703
4704 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4705 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004706 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004707 VkFormat view_format = pCreateInfo->format;
4708 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004709 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004710 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004711
Dave Houltonbd2e2622018-04-10 16:41:14 -06004712 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004713 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004714 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004715 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004716 if (!device_extensions.vk_ext_separate_stencil_usage) {
4717 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004718 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4719 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4720 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004721 }
4722 } else {
4723 const auto image_stencil_struct =
4724 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4725 if (image_stencil_struct == nullptr) {
4726 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004727 skip |= LogError(
4728 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004729 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4730 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4731 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4732 }
4733 } else {
4734 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4735 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4736 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004737 skip |= LogError(
4738 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004739 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4740 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4741 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4742 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4743 }
4744 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4745 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004746 skip |= LogError(
4747 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004748 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4749 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4750 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4751 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4752 }
4753 }
4754 }
4755 }
4756
Dave Houltonbd2e2622018-04-10 16:41:14 -06004757 image_usage = chained_ivuci_struct->usage;
4758 }
4759
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004760 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4761 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004762 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004763 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004764 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004765 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004766 std::stringstream ss;
4767 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004768 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004769 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004770 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004771 }
4772 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004773 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06004774 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4775 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004776 const char *error_vuid;
4777 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4778 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4779 } else if ((device_extensions.vk_khr_maintenance2) &&
4780 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4781 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4782 } else if ((!device_extensions.vk_khr_maintenance2) &&
4783 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4784 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4785 } else {
4786 // both enabled
4787 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4788 }
Dave Houltonc7988072018-04-16 11:46:56 -06004789 std::stringstream ss;
4790 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004791 << " is not in the same format compatibility class as "
4792 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004793 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4794 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004795 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004796 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004797 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004798 }
4799 } else {
4800 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004801 // Unless it is a multi-planar color bit aspect
4802 if ((image_format != view_format) &&
4803 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4804 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4805 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004806 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004807 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004808 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004809 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004810 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004811 }
4812 }
4813
4814 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004815 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004816
4817 switch (image_type) {
4818 case VK_IMAGE_TYPE_1D:
4819 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004820 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4821 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4822 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004823 }
4824 break;
4825 case VK_IMAGE_TYPE_2D:
4826 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4827 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4828 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004829 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4830 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4831 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004832 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004833 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4834 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4835 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004836 }
4837 }
4838 break;
4839 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004840 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004841 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4842 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4843 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004844 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004845 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4846 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4847 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004848 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4849 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004850 skip |= LogError(
4851 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4852 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4853 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4854 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4855 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004856 }
4857 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004858 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4859 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4860 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004861 }
4862 }
4863 } else {
4864 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
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 break;
4871 default:
4872 break;
4873 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004874
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004875 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004876 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004877 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004878 }
4879
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004880 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004881
Jeff Bolz9af91c52018-09-01 21:53:57 -05004882 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4883 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004884 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4885 "vkCreateImageView() If image was created with usage containing "
4886 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4887 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004888 }
4889 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004890 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4891 "vkCreateImageView() If image was created with usage containing "
4892 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004893 }
4894 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05004895
4896 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
4897 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
4898 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
4899 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
4900 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
4901 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
4902 }
4903 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
4904 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
4905 skip |= LogError(
4906 device, "VUID-VkImageViewCreateInfo-viewType-02963",
4907 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
4908 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
4909 }
4910 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004911 }
4912 return skip;
4913}
4914
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004915bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4916 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004917 bool skip = false;
4918
4919 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4920 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4921 VkDeviceSize src_min = UINT64_MAX;
4922 VkDeviceSize src_max = 0;
4923 VkDeviceSize dst_min = UINT64_MAX;
4924 VkDeviceSize dst_max = 0;
4925
4926 for (uint32_t i = 0; i < regionCount; i++) {
4927 src_min = std::min(src_min, pRegions[i].srcOffset);
4928 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4929 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4930 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4931
4932 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4933 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004934 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
4935 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4936 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4937 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004938 }
4939
4940 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4941 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004942 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
4943 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4944 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4945 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004946 }
4947
4948 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4949 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004950 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
4951 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4952 ") is greater than the source buffer size (%" PRIuLEAST64
4953 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4954 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004955 }
4956
4957 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4958 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004959 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
4960 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4961 ") is greater than the destination buffer size (%" PRIuLEAST64
4962 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4963 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004964 }
4965 }
4966
4967 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4968 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4969 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004970 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
4971 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004972 }
4973 }
4974
4975 return skip;
4976}
4977
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004978bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004979 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004980 const auto cb_node = GetCBState(commandBuffer);
4981 const auto src_buffer_state = GetBufferState(srcBuffer);
4982 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004983
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004984 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004985 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4986 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004987 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004988 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004989 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4990 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004991 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004992 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4993 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004994 skip |=
4995 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4996 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004997 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4998 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004999 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005000 return skip;
5001}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005002
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005003bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005004 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005005 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005006 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005007 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
5008 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005009 } else {
5010 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005011 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5012 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005013 }
5014 }
5015 return skip;
5016}
5017
Jeff Bolz5c801d12019-10-09 10:38:45 -05005018bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5019 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005020 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005021 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005022
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005023 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005024 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005025 skip |=
5026 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005027 }
5028 return skip;
5029}
5030
Jeff Bolz5c801d12019-10-09 10:38:45 -05005031bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005032 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005033
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005034 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005035 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005036 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005037 }
5038 return skip;
5039}
5040
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005041bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005042 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005043 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005044 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005045 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005046 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005047 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005048 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005049 }
5050 return skip;
5051}
5052
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005053bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005054 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005055 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005056 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005057 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005058 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005059 skip |=
5060 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5061 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005062 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005063 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005064 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5065 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005066 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005067
5068 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005069 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5070 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5071 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5072 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005073 }
5074
5075 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005076 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5077 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5078 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5079 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005080 }
5081
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005082 return skip;
5083}
5084
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005085bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
5086 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005087 bool skip = false;
5088
5089 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005090 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5091 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005092 skip |=
5093 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
5094 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5095 "and 1, respectively.",
5096 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005097 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005098 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005099
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005100 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5101 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005102 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
5103 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
5104 "must be 0 and 1, respectively.",
5105 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005106 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005107 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005108
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005109 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5110 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005111 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
5112 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5113 "For 3D images these must be 0 and 1, respectively.",
5114 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005115 }
5116 }
5117
5118 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005119 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07005120 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
5121
Dave Houltona585d132019-01-18 13:05:42 -07005122 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005123 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00193",
5124 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5125 " must be a multiple of this format's texel size (%" PRIu32 ").",
5126 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005127 }
5128
5129 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06005130 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005131 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00194",
5132 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
5133 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005134 }
5135
5136 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5137 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005138 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005139 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
5140 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5141 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005142 }
5143
5144 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5145 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005146 skip |= LogError(
5147 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005148 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5149 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005150 }
5151
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005152 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005153 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005154 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005155 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 -06005156 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5157 static_cast<int32_t>(adjusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005158 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
5159 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5160 "zero or <= image subresource width (%d).",
5161 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005162 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005163 }
5164
5165 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005166 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 -06005167 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5168 static_cast<int32_t>(adjusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005169 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
5170 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5171 "zero or <= image subresource height (%d).",
5172 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005173 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005174 }
5175
5176 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005177 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 -06005178 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5179 static_cast<int32_t>(adjusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005180 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
5181 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5182 "zero or <= image subresource depth (%d).",
5183 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005184 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005185 }
5186
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005187 // subresource aspectMask must have exactly 1 bit set
5188 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
5189 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
5190 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005191 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
5192 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005193 }
5194
5195 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06005196 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005197 skip |= LogError(
5198 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005199 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5200 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005201 }
5202
5203 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04005204 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005205 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005206
5207 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005208 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005209 skip |= LogError(
5210 image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005211 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5212 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005213 }
5214
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005215 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005216 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005217 skip |= LogError(
5218 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005219 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5220 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005221 }
5222
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005223 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005224 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5225 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5226 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005227 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00205",
5228 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5229 "width & height (%d, %d)..",
5230 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5231 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005232 }
5233
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005234 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07005235 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005236 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005237 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00206",
5238 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5239 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5240 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005241 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005242
5243 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005244 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005245 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005246 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005247 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00207",
5248 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5249 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5250 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5251 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005252 }
5253
5254 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005255 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005256 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005257 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00208",
5258 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5259 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5260 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5261 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005262 }
5263
5264 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005265 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005266 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005267 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00209",
5268 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5269 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5270 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5271 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005272 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005273 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005274
5275 // Checks that apply only to multi-planar format images
5276 if (FormatIsMultiplane(image_state->createInfo.format)) {
5277 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5278 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5279 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005280 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5281 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5282 "format has three planes.",
5283 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005284 }
5285
5286 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5287 if (0 == (pRegions[i].imageSubresource.aspectMask &
5288 (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 -07005289 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5290 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5291 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5292 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005293 }
5294 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005295 }
5296
5297 return skip;
5298}
5299
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005300bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5301 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005302 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005303 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005304
5305 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005306 VkExtent3D extent = pRegions[i].imageExtent;
5307 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005308
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005309 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5310 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005311 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5312 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5313 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005314 }
5315
5316 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5317
5318 // 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 -06005319 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005320 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005321 if (image_extent.width % block_extent.width) {
5322 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5323 }
5324 if (image_extent.height % block_extent.height) {
5325 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5326 }
5327 if (image_extent.depth % block_extent.depth) {
5328 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5329 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005330 }
5331
Dave Houltonfc1a4052017-04-27 14:32:45 -06005332 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005333 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005334 }
5335 }
5336
5337 return skip;
5338}
5339
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005340bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5341 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005342 bool skip = false;
5343
5344 VkDeviceSize buffer_size = buff_state->createInfo.size;
5345
5346 for (uint32_t i = 0; i < regionCount; i++) {
5347 VkExtent3D copy_extent = pRegions[i].imageExtent;
5348
5349 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5350 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005351 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5352 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005353
Tom Cooperb2550c72018-10-15 13:08:41 +01005354 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005355 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005356 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005357 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5358 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5359
5360 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5361 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5362 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005363 }
5364
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005365 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5366 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5367 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005368 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005369 } else {
5370 // Calculate buffer offset of final copied byte, + 1.
5371 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5372 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5373 max_buffer_offset *= unit_size; // convert to bytes
5374 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005375
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005376 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005377 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5378 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005379 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005380 }
5381 }
5382
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005383 return skip;
5384}
5385
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005386bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005387 VkBuffer dstBuffer, uint32_t regionCount,
5388 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005389 const auto cb_node = GetCBState(commandBuffer);
5390 const auto src_image_state = GetImageState(srcImage);
5391 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005392
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005393 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005394
5395 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005396 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005397
5398 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005399 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005400
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005401 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005402
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005403 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005404 skip |=
5405 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5406 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5407 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005408 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005409 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005410 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005411 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005412 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005413
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005414 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005415 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005416 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5417 skip |=
5418 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005419
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005420 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005421 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005422 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5423 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005424 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005425 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5426 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005427 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005428 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005429 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005430 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005431 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005432 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005433 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5434 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5435 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005436 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005437 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005438 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005439 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005440 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5441 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005442 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5443 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5444 skip |=
5445 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5446 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5447 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005448 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5449 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005450 }
5451 return skip;
5452}
5453
John Zulauf1686f232019-07-09 16:27:11 -06005454void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5455 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5456 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5457
5458 auto cb_node = GetCBState(commandBuffer);
5459 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005460 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005461 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005462 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005463 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005464}
5465
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005466bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5467 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005468 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005469 const auto cb_node = GetCBState(commandBuffer);
5470 const auto src_buffer_state = GetBufferState(srcBuffer);
5471 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005472
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005473 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005474
5475 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005476 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005477
5478 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005479 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005480 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005481 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005482 skip |=
5483 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5484 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5485 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005486 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005487 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005488 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005489 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005490 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005491 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005492 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005493 skip |=
5494 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5495 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005496 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005497 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5498 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005499 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005500 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5501 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005502 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005503 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005504 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005505 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005506 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005507 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005508 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5509 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5510 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005511 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005512 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005513 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005514 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005515 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5516 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005517 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5518 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5519 skip |=
5520 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5521 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5522 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005523 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5524 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005525 }
5526 return skip;
5527}
5528
John Zulauf1686f232019-07-09 16:27:11 -06005529void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5530 VkImageLayout dstImageLayout, uint32_t regionCount,
5531 const VkBufferImageCopy *pRegions) {
5532 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5533
5534 auto cb_node = GetCBState(commandBuffer);
5535 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005536 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005537 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005538 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005539 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005540}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005541
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005542bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005543 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005544 bool skip = false;
5545 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5546
Dave Houlton1d960ff2018-01-19 12:17:05 -07005547 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005548 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5549 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5550 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005551 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5552 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005553 }
5554
John Zulaufa26d3c82019-08-14 16:09:08 -06005555 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005556 if (!image_entry) {
5557 return skip;
5558 }
5559
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005560 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5561 if (device_extensions.vk_ext_image_drm_format_modifier) {
5562 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5563 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005564 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5565 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5566 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005567 }
5568 } else {
5569 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005570 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5571 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005572 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005573 }
5574
Dave Houlton1d960ff2018-01-19 12:17:05 -07005575 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005576 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005577 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5578 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5579 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005580 }
5581
Dave Houlton1d960ff2018-01-19 12:17:05 -07005582 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005583 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005584 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5585 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5586 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005587 }
5588
Dave Houlton1d960ff2018-01-19 12:17:05 -07005589 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005590 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005591 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5592 if (FormatIsMultiplane(img_format)) {
5593 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5594 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5595 if (FormatPlaneCount(img_format) > 2u) {
5596 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5597 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5598 }
5599 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005600 skip |= LogError(image, vuid,
5601 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5602 ") must be a single-plane specifier flag.",
5603 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005604 }
5605 } else if (FormatIsColor(img_format)) {
5606 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005607 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5608 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5609 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005610 }
5611 } else if (FormatIsDepthOrStencil(img_format)) {
5612 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5613 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005614 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005615 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5616 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5617 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5618 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005619 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5620 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5621 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005622 }
5623 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005624
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005625 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005626 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005627 }
5628
Mike Weiblen672b58b2017-02-21 14:32:53 -07005629 return skip;
5630}