blob: e70bb2f4a67e3b4bc781c9283676a7fcf9e11531 [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),
77 imported_ahb(false),
78 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -070079 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -060080 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -070081 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -060082 create_from_swapchain(VK_NULL_HANDLE),
83 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -060084 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -070085 range_encoder(full_range),
unknown08c57af2019-06-21 16:33:35 -060086 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060087 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
88 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
89 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
90 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
91 }
92 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
93 }
94
95 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
96 sparse = true;
97 }
Locked8af3732019-05-10 09:47:56 -060098
sfricke-samsunge2441192019-11-06 14:07:57 -080099 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
100 if (externalMemoryInfo) {
101 external_memory_handle = externalMemoryInfo->handleTypes;
102 }
103
Locked8af3732019-05-10 09:47:56 -0600104#ifdef VK_USE_PLATFORM_ANDROID_KHR
105 auto external_format = lvl_find_in_chain<VkExternalFormatANDROID>(createInfo.pNext);
106 if (external_format) {
107 external_format_android = external_format->externalFormat;
108 } else {
109 // If externalFormat is zero, the effect is as if the VkExternalFormatANDROID structure was not present.
110 external_format_android = 0;
111 }
112#endif // VK_USE_PLATFORM_ANDROID_KHR
John Zulauff660ad62019-03-23 07:16:05 -0600113}
114
unknown2c877272019-07-11 12:56:50 -0600115bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
116 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
117 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
118 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
119 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
120 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
121 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
122 return is_equal && IsQueueFamilyIndicesEqual(other_createInfo);
123}
124
Jeff Bolz82f854d2019-09-17 14:56:47 -0500125// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
126bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
127 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
128 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
129 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
130 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
131 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
132 is_compatible = is_compatible && IsQueueFamilyIndicesEqual(other_createInfo) && IsTilingEqual(other_createInfo);
133
134 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
135 createInfo.extent.height <= other_createInfo.extent.height &&
136 createInfo.extent.depth <= other_createInfo.extent.depth &&
137 createInfo.arrayLayers <= other_createInfo.arrayLayers;
138 return is_compatible;
139}
140
unknown2c877272019-07-11 12:56:50 -0600141bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700142 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
143 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
144 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700145 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
146 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600147 IsCreateInfoEqual(other_image_state->createInfo)) {
148 return true;
149 }
unknowne1661522019-07-11 13:04:18 -0600150 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
151 return true;
152 }
unknown2c877272019-07-11 12:56:50 -0600153 return false;
154}
155
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500156IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
157 : image_view(iv),
158 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700159 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
160 range_generator(im->range_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500161 samplerConversion(VK_NULL_HANDLE),
162 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600163 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
164 if (conversionInfo) samplerConversion = conversionInfo->conversion;
165 if (image_state) {
166 // A light normalization of the createInfo range
167 auto &sub_res_range = create_info.subresourceRange;
168 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
169 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
170
171 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700172 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500173 samples = image_state->createInfo.samples;
174 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600175 }
176}
177
Dave Houltond9611312018-11-19 17:03:36 -0700178uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
179 // uint cast applies floor()
180 return 1u + (uint32_t)log2(std::max({height, width, depth}));
181}
182
183uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
184
185uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
186
John Zulaufb58415b2019-12-09 15:02:32 -0700187static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
188 const VkImageSubresourceRange &range) {
John Zulauff660ad62019-03-23 07:16:05 -0600189 VkImageSubresourceRange norm = range;
190 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
191
192 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
193 // <arrayLayers> can potentially alias.
194 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
195 ? image_create_info.extent.depth
196 : image_create_info.arrayLayers;
197 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
198
199 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
200 VkImageAspectFlags &aspect_mask = norm.aspectMask;
201 if (FormatIsMultiplane(image_create_info.format)) {
202 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
203 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
204 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
205 if (FormatPlaneCount(image_create_info.format) > 2) {
206 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
207 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700208 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700209 }
John Zulauff660ad62019-03-23 07:16:05 -0600210 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700211}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700212
John Zulaufb58415b2019-12-09 15:02:32 -0700213VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
214 const VkImageCreateInfo &image_create_info = image_state.createInfo;
215 return NormalizeSubresourceRange(image_create_info, range);
216}
217
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500218bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700219 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700220 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700221
John Zulauf2076e812020-01-08 14:55:54 -0700222 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
223 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700224 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
225 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
226
John Zulauf2076e812020-01-08 14:55:54 -0700227 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
228
229 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
230 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700231 return false;
232 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700233
John Zulauf2076e812020-01-08 14:55:54 -0700234 for (auto entry : *layout_range_map) {
235 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700236 }
237 return true;
238}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700239
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600240// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600241void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600242 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
243 VkImageLayout expected_layout) {
244 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
245 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600246 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600247 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700248 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700249 for (const auto &image : image_state.aliasing_images) {
250 auto alias_state = GetImageState(image);
251 // The map state of the aliases should all be in sync, so no need to check the return value
252 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
253 assert(subresource_map);
254 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
255 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700256}
John Zulauff660ad62019-03-23 07:16:05 -0600257
258// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600259void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500260 if (disabled.image_layout_validation) {
261 return;
262 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500263 IMAGE_STATE *image_state = view_state.image_state.get();
264 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700265 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700266 for (const auto &image : image_state->aliasing_images) {
267 image_state = GetImageState(image);
268 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
269 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
270 }
John Zulauff660ad62019-03-23 07:16:05 -0600271}
272
273// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600274void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600275 const VkImageSubresourceRange &range, VkImageLayout layout) {
276 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
277 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600278 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700279 for (const auto &image : image_state.aliasing_images) {
280 auto alias_state = GetImageState(image);
281 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
282 assert(subresource_map);
283 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
284 }
John Zulauff660ad62019-03-23 07:16:05 -0600285}
286
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600287void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600288 VkImageLayout layout) {
289 const IMAGE_STATE *image_state = GetImageState(image);
290 if (!image_state) return;
291 SetImageInitialLayout(cb_node, *image_state, range, layout);
292};
293
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600294void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600295 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
296 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600297}
Dave Houltonddd65c52018-05-08 14:58:01 -0600298
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600299// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700300void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
301 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500302 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600303
John Zulauff660ad62019-03-23 07:16:05 -0600304 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600305 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
306 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600307 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 -0600308 sub_range.baseArrayLayer = 0;
309 sub_range.layerCount = image_state->createInfo.extent.depth;
310 }
311
Piers Daniell4fde9b72019-11-27 16:19:46 -0700312 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
313 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
314 SetImageLayout(cb_node, *image_state, sub_range, layout);
315 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
316 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
317 } else {
318 SetImageLayout(cb_node, *image_state, sub_range, layout);
319 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600320}
321
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700322bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
323 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700324 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600325 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100326 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700327 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100328 const char *vuid;
329 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
330
331 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700332 skip |= LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
333 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
334 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
335 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100336 return skip;
337 }
338
339 auto image_usage = image_state->createInfo.usage;
340
341 // Check for layouts that mismatch image usages in the framebuffer
342 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800343 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100344 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700345 LogError(image, vuid,
346 "Layout/usage mismatch for attachment %u in %s"
347 " - the %s is %s but the image attached to %s via %s"
348 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
349 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
350 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100351 }
352
353 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
354 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800355 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100356 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700357 LogError(image, vuid,
358 "Layout/usage mismatch for attachment %u in %s"
359 " - the %s is %s but the image attached to %s via %s"
360 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
361 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
362 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100363 }
364
365 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800366 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100367 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700368 LogError(image, vuid,
369 "Layout/usage mismatch for attachment %u in %s"
370 " - the %s is %s but the image attached to %s via %s"
371 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
372 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
373 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100374 }
375
376 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800377 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100378 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700379 LogError(image, vuid,
380 "Layout/usage mismatch for attachment %u in %s"
381 " - the %s is %s but the image attached to %s via %s"
382 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
383 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
384 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100385 }
386
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600387 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100388 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
389 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
390 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
391 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
392 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800393 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700394 skip |= LogError(image, vuid,
395 "Layout/usage mismatch for attachment %u in %s"
396 " - the %s is %s but the image attached to %s via %s"
397 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
398 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
399 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
400 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100401 }
402 } else {
403 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
404 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
405 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
406 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700407 skip |= LogError(image, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
408 "Layout/usage mismatch for attachment %u in %s"
409 " - the %s is %s but the image attached to %s via %s"
410 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
411 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
412 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
413 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100414 }
415 }
416 return skip;
417}
418
John Zulauf17a01bb2019-08-09 16:41:19 -0600419bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700420 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600421 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600422 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700423 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700424 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100425 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100426
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700427 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100428 auto framebuffer = framebuffer_state->framebuffer;
429
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700430 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700431 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
432 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700433 }
John Zulauf8e308292018-09-21 11:34:37 -0600434
Tobias Hectorc9057422019-07-23 12:15:52 +0100435 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
436 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
437 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100438 }
439
Tobias Hectorc9057422019-07-23 12:15:52 +0100440 if (attachments != nullptr) {
441 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
442 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
443 auto image_view = attachments[i];
444 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100445
Tobias Hectorc9057422019-07-23 12:15:52 +0100446 if (!view_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700447 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
448 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
449 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
450 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100451 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100452 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100453
454 const VkImage image = view_state->create_info.image;
455 const IMAGE_STATE *image_state = GetImageState(image);
456
457 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700458 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
459 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
460 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
461 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100462 continue;
463 }
464 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
465 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
466
Piers Daniell7f894f62020-01-09 16:33:48 -0700467 // Default to expecting stencil in the same layout.
468 auto attachment_stencil_initial_layout = attachment_initial_layout;
469
470 // If a separate layout is specified, look for that.
471 const auto *attachment_description_stencil_layout =
472 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
473 if (attachment_description_stencil_layout) {
474 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
475 }
476
Tobias Hectorc9057422019-07-23 12:15:52 +0100477 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
478 // in common with the non-const version.)
479 const ImageSubresourceLayoutMap *subresource_map =
480 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
481
482 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
483 LayoutUseCheckAndMessage layout_check(subresource_map);
484 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700485 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
486 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
487 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700488
John Zulauf5e617452019-11-19 14:44:16 -0700489 // Allow for differing depth and stencil layouts
490 VkImageLayout check_layout = attachment_initial_layout;
491 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
492
493 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700494 subres_skip |= LogError(
495 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700496 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
497 "and the %s layout of the attachment is %s. The layouts must match, or the render "
498 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700499 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100500 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700501 }
John Zulauf5e617452019-11-19 14:44:16 -0700502
Tobias Hectorc9057422019-07-23 12:15:52 +0100503 skip |= subres_skip;
504 }
505
506 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
507 framebuffer, render_pass, i, "initial layout");
508
509 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
510 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100511 }
512
Tobias Hectorc9057422019-07-23 12:15:52 +0100513 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
514 auto &subpass = pRenderPassInfo->pSubpasses[j];
515 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
516 auto &attachment_ref = subpass.pInputAttachments[k];
517 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
518 auto image_view = attachments[attachment_ref.attachment];
519 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100520
Tobias Hectorc9057422019-07-23 12:15:52 +0100521 if (view_state) {
522 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700523 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
524 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100525 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100526 }
527 }
528 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100529
Tobias Hectorc9057422019-07-23 12:15:52 +0100530 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
531 auto &attachment_ref = subpass.pColorAttachments[k];
532 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
533 auto image_view = attachments[attachment_ref.attachment];
534 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100535
Tobias Hectorc9057422019-07-23 12:15:52 +0100536 if (view_state) {
537 auto image = view_state->create_info.image;
538 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
539 framebuffer, render_pass, attachment_ref.attachment,
540 "color attachment layout");
541 if (subpass.pResolveAttachments) {
542 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
543 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
544 attachment_ref.attachment, "resolve attachment layout");
545 }
546 }
547 }
548 }
549
550 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
551 auto &attachment_ref = *subpass.pDepthStencilAttachment;
552 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
553 auto image_view = attachments[attachment_ref.attachment];
554 auto view_state = GetImageViewState(image_view);
555
556 if (view_state) {
557 auto image = view_state->create_info.image;
558 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
559 framebuffer, render_pass, attachment_ref.attachment,
560 "input attachment layout");
561 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100562 }
563 }
564 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700565 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600566 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700567}
568
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600569void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700570 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700571 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700572 IMAGE_VIEW_STATE *image_view = nullptr;
573 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
574 const auto attachment_info =
575 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
576 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
577 } else {
578 image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
579 }
John Zulauf8e308292018-09-21 11:34:37 -0600580 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700581 VkImageLayout stencil_layout = kInvalidLayout;
582 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
583 if (attachment_reference_stencil_layout) {
584 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
585 }
586
587 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600588 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700589 }
590}
591
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600592void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
593 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700594 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700595
596 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700597 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700598 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700599 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700600 }
601 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700602 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700603 }
604 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700605 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700606 }
607 }
608}
609
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700610// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
611// 1. Transition into initialLayout state
612// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600613void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700614 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700615 // First transition into initialLayout
616 auto const rpci = render_pass_state->createInfo.ptr();
617 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700618 IMAGE_VIEW_STATE *view_state = nullptr;
619 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
620 const auto attachment_info =
621 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
622 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
623 } else {
624 view_state = GetAttachmentImageViewState(framebuffer_state, i);
625 }
John Zulauf8e308292018-09-21 11:34:37 -0600626 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700627 VkImageLayout stencil_layout = kInvalidLayout;
628 const auto *attachment_description_stencil_layout =
629 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
630 if (attachment_description_stencil_layout) {
631 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
632 }
633
634 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600635 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700636 }
637 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700638 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700639}
640
Dave Houlton10b39482017-03-16 13:18:15 -0600641bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600642 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600643 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600644 }
645 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600646 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600647 }
648 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600649 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600650 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700651 if (0 !=
652 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
653 if (FormatPlaneCount(format) == 1) return false;
654 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600655 return true;
656}
657
Mike Weiblen62d08a32017-03-07 22:18:27 -0700658// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200659bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
660 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600661 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700662 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200663 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600664 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700665
666 switch (layout) {
667 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
668 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600669 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700670 }
671 break;
672 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
673 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600674 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700675 }
676 break;
677 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
678 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600679 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700680 }
681 break;
682 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
683 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600684 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700685 }
686 break;
687 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
688 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600689 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700690 }
691 break;
692 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
693 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600694 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700695 }
696 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600697 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500698 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
699 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
700 }
701 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700702 default:
703 // Other VkImageLayout values do not have VUs defined in this context.
704 break;
705 }
706
Dave Houlton8e9f6542018-05-18 12:18:22 -0600707 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700708 skip |= LogError(img_barrier.image, msg_code,
709 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
710 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
711 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700712 }
713 return skip;
714}
715
716// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600717bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
718 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700719 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700720
Petr Krausad0096a2019-08-09 18:35:04 +0200721 // Scoreboard for checking for duplicate and inconsistent barriers to images
722 struct ImageBarrierScoreboardEntry {
723 uint32_t index;
724 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
725 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
726 const VkImageMemoryBarrier *barrier;
727 };
728 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
729 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
730
John Zulauf463c51e2018-05-31 13:29:20 -0600731 // Scoreboard for duplicate layout transition barriers within the list
732 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
733 ImageBarrierScoreboardImageMap layout_transitions;
734
Mike Weiblen62d08a32017-03-07 22:18:27 -0700735 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200736 const auto &img_barrier = pImageMemoryBarriers[i];
737 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700738
John Zulauf463c51e2018-05-31 13:29:20 -0600739 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
740 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
741 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200742 if (img_barrier.oldLayout != img_barrier.newLayout) {
743 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
744 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600745 if (image_it != layout_transitions.end()) {
746 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200747 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600748 if (subres_it != subres_map.end()) {
749 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200750 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
751 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
752 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700753 skip = LogError(
754 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200755 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600756 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
757 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200758 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
759 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
760 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600761 }
762 entry = new_entry;
763 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200764 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600765 }
766 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200767 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600768 }
769 }
770
Petr Krausad0096a2019-08-09 18:35:04 +0200771 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600772 if (image_state) {
773 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200774 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
775 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600776
777 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
778 if (image_state->layout_locked) {
779 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700780 skip |= LogError(
781 img_barrier.image, 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600782 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600783 " 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 +0200784 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
785 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600786 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600787
John Zulaufa4472282019-08-22 14:44:34 -0600788 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600789 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600790 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200791 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700792 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600793 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
794 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700795 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
796 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
797 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
798 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
799 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600800 }
801 } else {
802 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
803 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700804 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03320",
805 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
806 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
807 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
808 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600809 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700810 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700811 }
John Zulauff660ad62019-03-23 07:16:05 -0600812
Petr Krausad0096a2019-08-09 18:35:04 +0200813 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
814 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600815 // TODO: Set memory invalid which is in mem_tracker currently
816 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
817 // subresource.
818 } else if (subresource_map) {
819 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600820 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200821 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700822 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
823 const auto &value = *pos;
824 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700825 subres_skip = LogError(
826 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
John Zulauf5e617452019-11-19 14:44:16 -0700827 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
828 "%s layout is %s.",
829 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
830 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
831 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600832 }
John Zulauf5e617452019-11-19 14:44:16 -0700833 }
John Zulauff660ad62019-03-23 07:16:05 -0600834 skip |= subres_skip;
835 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700836 }
837 }
838 return skip;
839}
840
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600841bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200842 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700843
Jeff Bolz6835fda2019-10-06 00:15:34 -0500844 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200845 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700846}
847
John Zulauf6b4aae82018-05-09 13:03:36 -0600848template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600849bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
850 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600851 using BarrierRecord = QFOTransferBarrier<Barrier>;
852 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500853 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600854 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
855 const char *barrier_name = BarrierRecord::BarrierName();
856 const char *handle_name = BarrierRecord::HandleName();
857 const char *transfer_type = nullptr;
858 for (uint32_t b = 0; b < barrier_count; b++) {
859 if (!IsTransferOp(&barriers[b])) continue;
860 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700861 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600862 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600863 const auto found = barrier_sets.release.find(barriers[b]);
864 if (found != barrier_sets.release.cend()) {
865 barrier_record = &(*found);
866 transfer_type = "releasing";
867 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600868 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600869 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600870 const auto found = barrier_sets.acquire.find(barriers[b]);
871 if (found != barrier_sets.acquire.cend()) {
872 barrier_record = &(*found);
873 transfer_type = "acquiring";
874 }
875 }
876 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700877 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
878 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
879 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
880 func_name, barrier_name, b, transfer_type, handle_name,
881 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
882 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600883 }
884 }
885 return skip;
886}
887
John Zulaufa4472282019-08-22 14:44:34 -0600888VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
889 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
890}
891
892const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
893 return device_state.GetImageState(barrier.image);
894}
895
896VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
897 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
898}
899
900const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
901 return device_state.GetBufferState(barrier.buffer);
902}
903
904VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
905
John Zulauf6b4aae82018-05-09 13:03:36 -0600906template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600907void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
908 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500909 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600910 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
911 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600912 auto &barrier = barriers[b];
913 if (IsTransferOp(&barrier)) {
914 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
915 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
916 barrier_sets.release.emplace(barrier);
917 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
918 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
919 barrier_sets.acquire.emplace(barrier);
920 }
921 }
922
923 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
924 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
925 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
926 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
927 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
928 auto handle_state = BarrierHandleState(*this, barrier);
929 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
930 if (!mode_concurrent) {
931 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -0500932 cb_state->queue_submit_functions.emplace_back(
933 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
934 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
935 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
936 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -0600937 });
938 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600939 }
940 }
941}
942
John Zulaufa4472282019-08-22 14:44:34 -0600943bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600944 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700945 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -0600946 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600947 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700948 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
949 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600950 return skip;
951}
952
John Zulaufa4472282019-08-22 14:44:34 -0600953void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
954 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
955 const VkImageMemoryBarrier *pImageMemBarriers) {
956 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
957 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600958}
959
960template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600961bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600962 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600963 // Record to the scoreboard or report that we have a duplication
964 bool skip = false;
965 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
966 if (!inserted.second && inserted.first->second != cb_state) {
967 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700968 skip = LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
969 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
970 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
971 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
972 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
973 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600974 }
975 return skip;
976}
977
978template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -0600979bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
980 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600981 using BarrierRecord = QFOTransferBarrier<Barrier>;
982 using TypeTag = typename BarrierRecord::Tag;
983 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600984 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700985 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600986 const char *barrier_name = BarrierRecord::BarrierName();
987 const char *handle_name = BarrierRecord::HandleName();
988 // No release should have an extant duplicate (WARNING)
989 for (const auto &release : cb_barriers.release) {
990 // Check the global pending release barriers
991 const auto set_it = global_release_barriers.find(release.handle);
992 if (set_it != global_release_barriers.cend()) {
993 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
994 const auto found = set_for_handle.find(release);
995 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700996 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
997 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
998 " to dstQueueFamilyIndex %" PRIu32
999 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1000 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1001 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001002 }
1003 }
1004 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1005 }
1006 // Each acquire must have a matching release (ERROR)
1007 for (const auto &acquire : cb_barriers.acquire) {
1008 const auto set_it = global_release_barriers.find(acquire.handle);
1009 bool matching_release_found = false;
1010 if (set_it != global_release_barriers.cend()) {
1011 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1012 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1013 }
1014 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001015 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1016 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1017 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1018 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1019 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001020 }
1021 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1022 }
1023 return skip;
1024}
1025
John Zulauf3b04ebd2019-07-18 14:08:11 -06001026bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001027 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001028 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001029 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001030 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1031 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001032 return skip;
1033}
1034
1035template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001036void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001037 using BarrierRecord = QFOTransferBarrier<Barrier>;
1038 using TypeTag = typename BarrierRecord::Tag;
1039 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001040 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001041
1042 // Add release barriers from this submit to the global map
1043 for (const auto &release : cb_barriers.release) {
1044 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1045 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1046 global_release_barriers[release.handle].insert(release);
1047 }
1048
1049 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1050 for (const auto &acquire : cb_barriers.acquire) {
1051 // NOTE: We're not using [] because we don't want to create entries for missing releases
1052 auto set_it = global_release_barriers.find(acquire.handle);
1053 if (set_it != global_release_barriers.end()) {
1054 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1055 set_for_handle.erase(acquire);
1056 if (set_for_handle.size() == 0) { // Clean up empty sets
1057 global_release_barriers.erase(set_it);
1058 }
1059 }
1060 }
1061}
1062
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001063void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001064 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1065 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001066}
1067
John Zulauf6b4aae82018-05-09 13:03:36 -06001068// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001069void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001070
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001071void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001072 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001073 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001074 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001075
Chris Forbes4de4b132017-08-21 11:27:08 -07001076 // For ownership transfers, the barrier is specified twice; as a release
1077 // operation on the yielding queue family, and as an acquire operation
1078 // on the acquiring queue family. This barrier may also include a layout
1079 // transition, which occurs 'between' the two operations. For validation
1080 // purposes it doesn't seem important which side performs the layout
1081 // transition, but it must not be performed twice. We'll arbitrarily
1082 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001083 //
1084 // However, we still need to record initial layout for the "initial layout" validation
1085 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001086
Petr Krausad0096a2019-08-09 18:35:04 +02001087 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001088 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001089 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001090 }
1091}
1092
unknown86bcb3a2019-07-11 13:05:36 -06001093void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001094 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001095 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1096 const auto &image_create_info = image_state->createInfo;
1097
1098 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1099 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1100 // for all (potential) layer sub_resources.
1101 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1102 normalized_isr.baseArrayLayer = 0;
1103 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1104 }
1105
John Zulauf2be3fe02019-12-30 09:48:02 -07001106 if (is_release_op) {
1107 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1108 } else {
1109 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1110 }
unknown86bcb3a2019-07-11 13:05:36 -06001111}
1112
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001113bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1114 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1115 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1116 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001117 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001118 assert(cb_node);
1119 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001120 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001121 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001122
John Zulauff660ad62019-03-23 07:16:05 -06001123 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1124 if (subresource_map) {
1125 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001126 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001127 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1128 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001129 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001130 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1131 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1132 "%s layout %s.",
1133 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1134 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1135 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001136 }
John Zulauf5e617452019-11-19 14:44:16 -07001137 }
John Zulauff660ad62019-03-23 07:16:05 -06001138 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001139 }
John Zulauff660ad62019-03-23 07:16:05 -06001140
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001141 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1142 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1143 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001144 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1145 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001146 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1147 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1148 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001149 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001150 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001151 if (image_state->shared_presentable) {
1152 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001153 skip |= LogError(device, layout_invalid_msg_code,
1154 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1155 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001156 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001157 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001158 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001159 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001160 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1161 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1162 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1163 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001164 }
1165 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001166 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001167}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001168bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001169 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1170 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001171 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001172 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1173 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1174}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001175
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001176void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001177 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001178 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001179 if (!renderPass) return;
1180
Tobias Hectorbbb12282018-10-22 15:17:59 +01001181 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001182 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001183 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001184 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001185 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1186 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1187 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1188 } else {
1189 view_state = GetAttachmentImageViewState(framebuffer_state, i);
1190 }
John Zulauf8e308292018-09-21 11:34:37 -06001191 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001192 VkImageLayout stencil_layout = kInvalidLayout;
1193 const auto *attachment_description_stencil_layout =
1194 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1195 if (attachment_description_stencil_layout) {
1196 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1197 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001198 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001199 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001200 }
1201 }
1202}
Dave Houltone19e20d2018-02-02 16:32:41 -07001203
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001204#ifdef VK_USE_PLATFORM_ANDROID_KHR
1205// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1206// This could also move into a seperate core_validation_android.cpp file... ?
1207
1208//
1209// AHB-specific validation within non-AHB APIs
1210//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001211bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001212 bool skip = false;
1213
1214 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1215 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001216 if (0 != ext_fmt_android->externalFormat) {
1217 if (VK_FORMAT_UNDEFINED != create_info->format) {
1218 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001219 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1220 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1221 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001222 }
1223
1224 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001225 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1226 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1227 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001228 }
1229
1230 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001231 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1232 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1233 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001234 }
1235
1236 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001237 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1238 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1239 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001240 }
1241 }
1242
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001243 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001244 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
1245 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
1246 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001247 }
1248 }
1249
Dave Houltond9611312018-11-19 17:03:36 -07001250 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001251 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001252 skip |=
1253 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1254 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1255 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001256 }
1257 }
1258
1259 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1260 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1261 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001262 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001263 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1264 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1265 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1266 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001267 }
1268
1269 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001270 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1271 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1272 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1273 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1274 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001275 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001276 }
1277
1278 return skip;
1279}
1280
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001281bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001282 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001283 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001284
1285 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001286 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001287 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1288 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1289 "format member is %s.",
1290 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001291 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001292
Dave Houltond9611312018-11-19 17:03:36 -07001293 // Chain must include a compatible ycbcr conversion
1294 bool conv_found = false;
1295 uint64_t external_format = 0;
1296 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1297 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001298 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001299 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001300 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001301 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001302 }
Dave Houltond9611312018-11-19 17:03:36 -07001303 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001304 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001305 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
1306 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1307 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
Dave Houltond9611312018-11-19 17:03:36 -07001308 }
1309
1310 // Errors in create_info swizzles
1311 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1312 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1313 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1314 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001315 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1316 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1317 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001318 }
1319 }
Dave Houltond9611312018-11-19 17:03:36 -07001320
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001321 return skip;
1322}
1323
John Zulaufa26d3c82019-08-14 16:09:08 -06001324bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001325 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001326
John Zulaufa26d3c82019-08-14 16:09:08 -06001327 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001328 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001329 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1330 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1331 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1332 "bound to memory.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001333 }
1334 return skip;
1335}
1336
1337#else
1338
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001339bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001340 return false;
1341}
1342
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001343bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001344
John Zulaufa26d3c82019-08-14 16:09:08 -06001345bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001346
1347#endif // VK_USE_PLATFORM_ANDROID_KHR
1348
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001349bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001350 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001351 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001352
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001353 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001354 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001355 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1356 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001357 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1358 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001359 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001360 }
1361
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001362 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1363 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001364 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1365 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1366 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001367 }
1368
1369 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001370 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1371 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1372 "height (%d) and arrayLayers (%d) must be >= 6.",
1373 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001374 }
Dave Houlton130c0212018-01-29 13:39:56 -07001375 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001376
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001377 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001378 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1379 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1380 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001381 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1382 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1383 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001384 }
1385
1386 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001387 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1388 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1389 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001390 }
1391
ByumjinConffx991b6062019-08-14 15:17:53 -07001392 if (device_extensions.vk_ext_fragment_density_map) {
1393 uint32_t ceiling_width =
1394 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1395 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1396 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1397 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001398 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1399 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1400 "ceiling of device "
1401 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1402 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1403 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001404 }
1405
1406 uint32_t ceiling_height =
1407 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1408 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1409 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1410 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001411 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1412 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1413 "ceiling of device "
1414 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1415 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1416 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001417 }
1418 }
1419
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001420 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001421 VkResult result = VK_SUCCESS;
1422 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1423 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1424 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1425 &format_limits);
1426 } else {
1427 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1428 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1429 image_format_info.type = pCreateInfo->imageType;
1430 image_format_info.tiling = pCreateInfo->tiling;
1431 image_format_info.usage = pCreateInfo->usage;
1432 image_format_info.flags = pCreateInfo->flags;
1433 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1434 format_limits = image_format_properties.imageFormatProperties;
1435 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001436
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001437 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001438#ifdef VK_USE_PLATFORM_ANDROID_KHR
1439 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1440#endif // VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001441 skip |=
1442 LogError(device, kVUIDUndefined, "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1443 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001444 } else {
1445 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1446 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001447 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1448 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1449 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001450 }
Dave Houlton130c0212018-01-29 13:39:56 -07001451
Dave Houltona585d132019-01-18 13:05:42 -07001452 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1453 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1454 (uint64_t)pCreateInfo->samples;
1455 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001456
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001457 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001458 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001459 uint64_t ig_mask = imageGranularity - 1;
1460 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001461
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001462 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001463 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1464 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1465 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1466 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001467 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001468
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001469 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001470 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1471 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1472 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001473 }
1474
1475 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001476 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1477 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1478 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001479 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001480 }
1481
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001482 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001483 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1484 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1485 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1486 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001487 skip |= LogError(device, error_vuid,
1488 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1489 "YCbCr Conversion format, arrayLayers must be 1",
1490 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001491 }
1492
1493 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001494 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1495 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1496 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001497 }
1498
1499 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001500 skip |= LogError(
1501 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001502 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1503 string_VkSampleCountFlagBits(pCreateInfo->samples));
1504 }
1505
1506 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001507 skip |= LogError(
1508 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001509 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1510 string_VkImageType(pCreateInfo->imageType));
1511 }
1512 }
1513
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001514 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001515 skip |=
1516 LogError(device, "VUID-VkImageCreateInfo-flags-01924",
1517 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1518 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001519 }
1520
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001521 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001522 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1523 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1524 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1525 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001526 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001527 LogError(device, kVUIDUndefined,
1528 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1529 "format must be block, ETC or ASTC compressed, but is %s",
1530 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001531 }
1532 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1533 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001534 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001535 LogError(device, kVUIDUndefined,
1536 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1537 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001538 }
1539 }
1540 }
1541
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001542 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001543 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1544 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1545 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001546 }
1547
unknown2c877272019-07-11 12:56:50 -06001548 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1549 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1550 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001551 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1552 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1553 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001554 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001555 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001556}
1557
John Zulauf7eeb6f72019-06-17 11:56:36 -06001558void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1559 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1560 if (VK_SUCCESS != result) return;
1561
1562 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001563 auto image_state = Get<IMAGE_STATE>(*pImage);
1564 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001565}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001566
Jeff Bolz5c801d12019-10-09 10:38:45 -05001567bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001568 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001569 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001570 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001571 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001572 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001573 }
1574 return skip;
1575}
1576
John Zulauf7eeb6f72019-06-17 11:56:36 -06001577void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1578 // Clean up validation specific data
1579 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001580
locke-lunargcba7d5f2019-12-30 16:59:11 -07001581 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001582
1583 // Clean up generic image state
1584 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001585}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001586
John Zulauf07288512019-07-05 11:09:50 -06001587bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001588 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001589
1590 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1591 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 -07001592 skip |= LogError(image_state->image, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001593 }
1594
Dave Houlton1d2022c2017-03-29 11:43:58 -06001595 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001596 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001597 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001598 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001599 char const str[] = "vkCmdClearColorImage called with compressed image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001600 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001601 }
1602
1603 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1604 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001605 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001606 }
1607 return skip;
1608}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001609
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001610uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1611 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1612 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001613 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001614 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001615 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001616 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001617}
1618
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001619uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1620 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1621 uint32_t array_layer_count = range->layerCount;
1622 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1623 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001624 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001625 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001626}
1627
John Zulauf07288512019-07-05 11:09:50 -06001628bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1629 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1630 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001631 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001632 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1633 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001634 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1635 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1636 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001637 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001638
1639 } else {
1640 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1641 if (!device_extensions.vk_khr_shared_presentable_image) {
1642 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001643 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1644 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1645 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001646 }
1647 } else {
1648 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1649 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001650 skip |= LogError(
1651 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001652 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1653 func_name, string_VkImageLayout(dest_image_layout));
1654 }
1655 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001656 }
1657
John Zulauff660ad62019-03-23 07:16:05 -06001658 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001659 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001660 if (subresource_map) {
1661 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001662 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001663 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001664 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1665 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001666 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1667 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1668 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1669 } else {
1670 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001671 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001672 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1673 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1674 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1675 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001676 }
John Zulauf5e617452019-11-19 14:44:16 -07001677 }
John Zulauff660ad62019-03-23 07:16:05 -06001678 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001679 }
1680
1681 return skip;
1682}
1683
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001684bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1685 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001686 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001687 bool skip = false;
1688 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001689 const auto *cb_node = GetCBState(commandBuffer);
1690 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001691 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001692 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001693 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001694 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001695 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001696 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001697 skip |=
1698 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1699 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001700 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001701 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001702 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001703 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001704 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001705 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1706 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001707 }
sfricke-samsunge775d492020-02-28 09:02:25 -08001708 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
1709 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
1710 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
1711 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
1712 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
1713 string_VkFormat(image_state->createInfo.format));
1714 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001715 }
1716 return skip;
1717}
1718
John Zulaufeabb4462019-07-05 14:13:03 -06001719void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1720 const VkClearColorValue *pColor, uint32_t rangeCount,
1721 const VkImageSubresourceRange *pRanges) {
1722 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1723
1724 auto cb_node = GetCBState(commandBuffer);
1725 auto image_state = GetImageState(image);
1726 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001727 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001728 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001729 }
1730 }
1731}
1732
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001733bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1734 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001735 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001736 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001737
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001738 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001739 const auto *cb_node = GetCBState(commandBuffer);
1740 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001741 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001742 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001743 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001744 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001745 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001746 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001747 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001748 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1749 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001750 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001751 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001752 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001753
1754 bool any_include_aspect_depth_bit = false;
1755 bool any_include_aspect_stencil_bit = false;
1756
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001757 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001758 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001759 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001760 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001761 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001762 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1763 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001764 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001765 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1766 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001767 skip |= LogError(commandBuffer, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001768 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001769 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1770 any_include_aspect_depth_bit = true;
1771 }
1772 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1773 any_include_aspect_stencil_bit = true;
1774 }
1775 }
1776 if (any_include_aspect_stencil_bit) {
1777 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1778 if (image_stencil_struct != nullptr) {
1779 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1780 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001781 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1782 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1783 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1784 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001785 }
1786 } else {
1787 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001788 skip |= LogError(
1789 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05001790 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1791 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1792 "in VkImageCreateInfo::usage used to create image");
1793 }
1794 }
1795 }
1796 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001797 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1798 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1799 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001800 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001801 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001802 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001803 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001804 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001805 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1806 char const str[] =
1807 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1808 "set.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001809 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001810 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001811 }
1812 return skip;
1813}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001814
John Zulaufeabb4462019-07-05 14:13:03 -06001815void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1816 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1817 const VkImageSubresourceRange *pRanges) {
1818 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1819 auto cb_node = GetCBState(commandBuffer);
1820 auto image_state = GetImageState(image);
1821 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001822 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001823 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001824 }
1825 }
1826}
1827
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001828// Returns true if [x, xoffset] and [y, yoffset] overlap
1829static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1830 bool result = false;
1831 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1832 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1833
1834 if (intersection_max > intersection_min) {
1835 result = true;
1836 }
1837 return result;
1838}
1839
Dave Houltonc991cc92018-03-06 11:08:51 -07001840// Returns true if source area of first copy region intersects dest area of second region
1841// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1842static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001843 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001844
Dave Houltonc991cc92018-03-06 11:08:51 -07001845 // Separate planes within a multiplane image cannot intersect
1846 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001847 return result;
1848 }
1849
Dave Houltonc991cc92018-03-06 11:08:51 -07001850 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1851 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1852 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001853 result = true;
1854 switch (type) {
1855 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001856 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001857 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001858 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001859 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001860 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001861 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001862 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001863 break;
1864 default:
1865 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1866 assert(false);
1867 }
1868 }
1869 return result;
1870}
1871
Dave Houltonfc1a4052017-04-27 14:32:45 -06001872// Returns non-zero if offset and extent exceed image extents
1873static const uint32_t x_bit = 1;
1874static const uint32_t y_bit = 2;
1875static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001876static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001877 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001878 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001879 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1880 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001881 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001882 }
1883 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1884 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001885 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001886 }
1887 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1888 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001889 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001890 }
1891 return result;
1892}
1893
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001894// Test if two VkExtent3D structs are equivalent
1895static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1896 bool result = true;
1897 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1898 (extent->depth != other_extent->depth)) {
1899 result = false;
1900 }
1901 return result;
1902}
1903
Dave Houltonee281a52017-12-08 13:51:02 -07001904// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1905// Destination image texel extents must be adjusted by block size for the dest validation checks
1906VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1907 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06001908 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1909 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001910 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001911 adjusted_extent.width /= block_size.width;
1912 adjusted_extent.height /= block_size.height;
1913 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06001914 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1915 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001916 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001917 adjusted_extent.width *= block_size.width;
1918 adjusted_extent.height *= block_size.height;
1919 adjusted_extent.depth *= block_size.depth;
1920 }
1921 return adjusted_extent;
1922}
1923
Dave Houlton6f9059e2017-05-02 17:15:13 -06001924// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001925static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1926 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001927
1928 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001929 if (mip >= img->createInfo.mipLevels) {
1930 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001931 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001932
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001933 // 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 -06001934 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001935
Dave Houltone48cd112019-01-03 17:01:18 -07001936 // If multi-plane, adjust per-plane extent
1937 if (FormatIsMultiplane(img->createInfo.format)) {
1938 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1939 extent.width /= divisors.width;
1940 extent.height /= divisors.height;
1941 }
1942
Jeff Bolzef40fec2018-09-01 22:04:34 -05001943 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1944 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001945 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001946 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1947 } else {
1948 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1949 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1950 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1951 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001952
Dave Houlton6f9059e2017-05-02 17:15:13 -06001953 // Image arrays have an effective z extent that isn't diminished by mip level
1954 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001955 extent.depth = img->createInfo.arrayLayers;
1956 }
1957
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001958 return extent;
1959}
1960
1961// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001962static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001963 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1964}
1965
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001966// Test if the extent argument has any dimensions set to 0.
1967static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1968 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1969}
1970
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001971// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001972VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001973 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1974 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05001975 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001976 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001977 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06001978 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001979 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001980 granularity.width *= block_size.width;
1981 granularity.height *= block_size.height;
1982 }
1983 }
1984 return granularity;
1985}
1986
1987// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1988static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1989 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001990 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1991 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001992 valid = false;
1993 }
1994 return valid;
1995}
1996
1997// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001998bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001999 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002000 bool skip = false;
2001 VkExtent3D offset_extent = {};
2002 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2003 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2004 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002005 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002006 // 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 -07002007 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002008 skip |= LogError(cb_node->commandBuffer, vuid,
2009 "%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 "
2010 "image transfer granularity is (w=0, h=0, d=0).",
2011 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002012 }
2013 } else {
2014 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2015 // integer multiples of the image transfer granularity.
2016 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002017 skip |= LogError(cb_node->commandBuffer, vuid,
2018 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2019 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2020 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2021 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002022 }
2023 }
2024 return skip;
2025}
2026
2027// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002028bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002029 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002030 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002031 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002032 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002033 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2034 // subresource extent.
2035 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002036 skip |= LogError(cb_node->commandBuffer, vuid,
2037 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2038 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2039 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2040 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002041 }
2042 } else {
2043 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2044 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2045 // subresource extent dimensions.
2046 VkExtent3D offset_extent_sum = {};
2047 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2048 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2049 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002050 bool x_ok = true;
2051 bool y_ok = true;
2052 bool z_ok = true;
2053 switch (image_type) {
2054 case VK_IMAGE_TYPE_3D:
2055 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2056 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002057 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002058 case VK_IMAGE_TYPE_2D:
2059 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2060 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002061 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002062 case VK_IMAGE_TYPE_1D:
2063 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2064 (subresource_extent->width == offset_extent_sum.width));
2065 break;
2066 default:
2067 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2068 assert(false);
2069 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002070 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002071 skip |=
2072 LogError(cb_node->commandBuffer, vuid,
2073 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2074 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2075 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2076 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2077 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2078 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002079 }
2080 }
2081 return skip;
2082}
2083
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002084bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002085 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002086 bool skip = false;
2087 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002088 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2089 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002090 }
2091 return skip;
2092}
2093
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002094bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002095 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002096 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002097 bool skip = false;
2098 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2099 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002100 skip |= LogError(cb_node->commandBuffer, vuid,
2101 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2102 "%u, but provided %s has %u array layers.",
2103 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2104 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002105 }
2106 return skip;
2107}
2108
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002109// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002110bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002111 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002112 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002113 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002114 VkExtent3D granularity = GetScaledItg(cb_node, img);
2115 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002116 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002117 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002118 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002119 return skip;
2120}
2121
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002122// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002123bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002124 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002125 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002126 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002127 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002128 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2129 skip |=
2130 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002131 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002132 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002133 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2134 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002135
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002136 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002137 granularity = GetScaledItg(cb_node, dst_img);
2138 skip |=
2139 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002140 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002141 const VkExtent3D dest_effective_extent =
2142 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002143 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002144 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002145 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002146 return skip;
2147}
2148
Dave Houlton6f9059e2017-05-02 17:15:13 -06002149// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002150bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002151 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002152 bool skip = false;
2153
2154 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002155 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002156
2157 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002158 const VkExtent3D src_copy_extent = region.extent;
2159 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002160 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2161
Dave Houlton6f9059e2017-05-02 17:15:13 -06002162 bool slice_override = false;
2163 uint32_t depth_slices = 0;
2164
2165 // Special case for copying between a 1D/2D array and a 3D image
2166 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2167 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002168 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002169 slice_override = (depth_slices != 1);
2170 } 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 -07002171 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002172 slice_override = (depth_slices != 1);
2173 }
2174
2175 // Do all checks on source image
2176 //
2177 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002178 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002179 skip |=
2180 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2181 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2182 "be 0 and 1, respectively.",
2183 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002184 }
2185 }
2186
Dave Houlton533be9f2018-03-26 17:08:30 -06002187 // VUID-VkImageCopy-srcImage-01785
2188 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 -07002189 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2190 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2191 "these must be 0 and 1, respectively.",
2192 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002193 }
2194
Dave Houlton533be9f2018-03-26 17:08:30 -06002195 // VUID-VkImageCopy-srcImage-01787
2196 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002197 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2198 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2199 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002200 }
2201
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002202 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002203 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002204 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002205 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002206 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2207 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2208 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2209 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002210 }
2211 }
2212 } else { // Pre maint 1
2213 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002214 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002215 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2216 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2217 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2218 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2219 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002220 }
2221 }
2222 }
2223
Dave Houltonc991cc92018-03-06 11:08:51 -07002224 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002225 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002226 if (FormatIsCompressed(src_state->createInfo.format) ||
2227 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002228 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002229 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002230 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2231 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2232 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002233 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002234 skip |= LogError(src_state->image, vuid,
2235 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2236 "texel width & height (%d, %d).",
2237 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002238 }
2239
Dave Houlton94a00372017-12-14 15:08:47 -07002240 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002241 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2242 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002243 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002244 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002245 LogError(src_state->image, vuid,
2246 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2247 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2248 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002249 }
2250
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002251 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002252 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2253 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002254 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002255 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002256 LogError(src_state->image, vuid,
2257 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2258 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2259 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002260 }
2261
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002262 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002263 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2264 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002265 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002266 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002267 LogError(src_state->image, vuid,
2268 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2269 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2270 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002271 }
2272 } // Compressed
2273
2274 // Do all checks on dest image
2275 //
2276 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002277 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002278 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2279 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2280 "these must be 0 and 1, respectively.",
2281 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002282 }
2283 }
2284
Dave Houlton533be9f2018-03-26 17:08:30 -06002285 // VUID-VkImageCopy-dstImage-01786
2286 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 -07002287 skip |=
2288 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2289 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2290 "and 1, respectively.",
2291 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002292 }
2293
2294 // VUID-VkImageCopy-dstImage-01788
2295 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002296 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2297 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2298 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002299 }
2300
2301 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002302 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002303 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2304 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2305 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2306 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002307 }
2308 }
2309 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002310 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002311 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002312 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002313 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002314 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2315 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2316 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2317 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002318 }
2319 }
2320 } else { // Pre maint 1
2321 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002322 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002323 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2324 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2325 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2326 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2327 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002328 }
2329 }
2330 }
2331
Dave Houltonc991cc92018-03-06 11:08:51 -07002332 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2333 if (FormatIsCompressed(dst_state->createInfo.format) ||
2334 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002335 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002336
2337 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002338 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2339 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2340 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002341 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002342 skip |= LogError(dst_state->image, vuid,
2343 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2344 "texel width & height (%d, %d).",
2345 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002346 }
2347
Dave Houlton94a00372017-12-14 15:08:47 -07002348 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002349 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2350 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002351 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002352 skip |= LogError(
2353 dst_state->image, vuid,
2354 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2355 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2356 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002357 }
2358
Dave Houltonee281a52017-12-08 13:51:02 -07002359 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2360 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2361 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002362 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002363 skip |= LogError(dst_state->image, vuid,
2364 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2365 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2366 "height (%d).",
2367 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002368 }
2369
Dave Houltonee281a52017-12-08 13:51:02 -07002370 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2371 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2372 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002373 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002374 skip |= LogError(
2375 dst_state->image, vuid,
2376 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2377 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2378 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002379 }
2380 } // Compressed
2381 }
2382 return skip;
2383}
2384
Dave Houltonc991cc92018-03-06 11:08:51 -07002385// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002386bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002387 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002388 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002389
2390 // Neither image is multiplane
2391 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2392 // If neither image is multi-plane the aspectMask member of src and dst must match
2393 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2394 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002395 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002396 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002397 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002398 }
2399 } else {
2400 // Source image multiplane checks
2401 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2402 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2403 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2404 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002405 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002406 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002407 }
2408 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2409 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2410 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002411 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002412 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002413 }
2414 // Single-plane to multi-plane
2415 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2416 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2417 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002418 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002419 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002420 }
2421
2422 // Dest image multiplane checks
2423 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2424 aspect = region.dstSubresource.aspectMask;
2425 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2426 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002427 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002428 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002429 }
2430 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2431 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2432 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002433 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002434 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002435 }
2436 // Multi-plane to single-plane
2437 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2438 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2439 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002440 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002441 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002442 }
2443 }
2444
2445 return skip;
2446}
2447
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002448bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2449 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002450 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002451 const auto *cb_node = GetCBState(commandBuffer);
2452 const auto *src_image_state = GetImageState(srcImage);
2453 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002454 const VkFormat src_format = src_image_state->createInfo.format;
2455 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002456 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002457
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002458 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002459
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002460 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2461
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002462 for (uint32_t i = 0; i < regionCount; i++) {
2463 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002464
2465 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2466 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002467 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002468
Dave Houlton6f9059e2017-05-02 17:15:13 -06002469 bool slice_override = false;
2470 uint32_t depth_slices = 0;
2471
2472 // Special case for copying between a 1D/2D array and a 3D image
2473 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2474 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2475 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002476 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002477 slice_override = (depth_slices != 1);
2478 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2479 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002480 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002481 slice_override = (depth_slices != 1);
2482 }
2483
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002484 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2485 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2486 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002487 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002488 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002489 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002490 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002491 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2492 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002493 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002494 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2495 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002496
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002497 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002498 // No chance of mismatch if we're overriding depth slice count
2499 if (!slice_override) {
2500 // The number of depth slices in srcSubresource and dstSubresource must match
2501 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2502 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002503 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2504 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002505 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002506 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2507 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002508 if (src_slices != dst_slices) {
2509 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002510 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002511 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002512 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002513 }
2514 }
2515 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002516 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002517 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002518 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002519 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002520 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002521 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002522 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002523 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002524
Dave Houltonc991cc92018-03-06 11:08:51 -07002525 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002526 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002527 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002528 }
2529
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002530 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002531 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2532 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002533 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002534 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002535 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002536 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002537
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002538 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002539 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002540 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002541 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002542 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002543 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002544 }
2545
2546 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002547 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002548 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002549 ss << "vkCmdCopyImage(): pRegion[" << i
2550 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002551 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002552 }
2553
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002554 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2555 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2556 // The source region specified by a given element of regions must be a region that is contained within srcImage
Dave Houltonee281a52017-12-08 13:51:02 -07002557 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2558 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002559 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002560 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002561 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2562 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2563 << " ] exceeds the source image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002564 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002565 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002566
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002567 // The destination region specified by a given element of regions must be a region that is contained within dst_image
Dave Houltonee281a52017-12-08 13:51:02 -07002568 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2569 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002570 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002571 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002572 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2573 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2574 << " ] exceeds the destination image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002575 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002576 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002577 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002578
Dave Houltonfc1a4052017-04-27 14:32:45 -06002579 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002580 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2581 if (slice_override) src_copy_extent.depth = depth_slices;
2582 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002583 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002584 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002585 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2586 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2587 "width [%1d].",
2588 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002589 }
2590
2591 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002592 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002593 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2594 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2595 "height [%1d].",
2596 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002597 }
2598 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002599 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002600 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2601 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2602 "depth [%1d].",
2603 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002604 }
2605
Dave Houltonee281a52017-12-08 13:51:02 -07002606 // Adjust dest extent if necessary
2607 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2608 if (slice_override) dst_copy_extent.depth = depth_slices;
2609
2610 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002611 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002612 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2613 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2614 "width [%1d].",
2615 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002616 }
2617 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002618 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2619 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2620 "height [%1d].",
2621 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002622 }
2623 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002624 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2625 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2626 "depth [%1d].",
2627 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002628 }
2629
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002630 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2631 // must not overlap in memory
2632 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002633 for (uint32_t j = 0; j < regionCount; j++) {
2634 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002635 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002636 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002637 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002638 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002639 }
2640 }
2641 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002642
2643 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2644 if (device_extensions.vk_khr_maintenance1) {
2645 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2646 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2647 (src_copy_extent.depth != 1)) {
2648 skip |= LogError(
2649 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2650 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2651 src_copy_extent.depth);
2652 }
2653 } else {
2654 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2655 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2656 (src_copy_extent.depth != 1)) {
2657 skip |= LogError(
2658 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2659 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2660 src_copy_extent.depth);
2661 }
2662 }
2663
2664 // Check if 2D with 3D and depth not equal to 2D layerCount
2665 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2666 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2667 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2668 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2669 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2670 "srcSubresource.layerCount (%u)",
2671 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2672 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2673 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2674 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2675 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2676 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2677 "dstSubresource.layerCount (%u)",
2678 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2679 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002680 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002681
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002682 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2683 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2684 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
sfricke-samsungdce5f692020-03-07 13:59:31 -08002685 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2686 if (src_format != dst_format) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002687 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002688 skip |= LogError(command_buffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002689 }
2690 } else {
sfricke-samsungdce5f692020-03-07 13:59:31 -08002691 if ((!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) && (!FormatIsMultiplane(src_format)) &&
2692 (!FormatIsMultiplane(dst_format))) {
2693 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2694 : "VUID-vkCmdCopyImage-srcImage-00135";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002695 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
sfricke-samsungdce5f692020-03-07 13:59:31 -08002696 skip |= LogError(command_buffer, vuid, "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002697 }
2698 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002699
Dave Houlton33c22b72017-02-28 13:16:02 -07002700 // Source and dest image sample counts must match
2701 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2702 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002703 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002704 }
2705
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002706 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2707 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002708 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002709 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2710 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2711 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2712 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002713 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002714 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2715 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2716 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2717 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002718 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002719 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002720 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002721 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2722 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002723 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002724 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2725 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2726 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2727 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2728 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2729 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002730 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002731 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002732 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2733 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002734 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002735 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2736 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002737 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2738 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002739 }
2740
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002741 return skip;
2742}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002743
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002744void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2745 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2746 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002747 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2748 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002749 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002750 auto src_image_state = GetImageState(srcImage);
2751 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002752
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002753 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002754 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002755 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2756 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002757 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002758}
2759
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002760// Returns true if sub_rect is entirely contained within rect
2761static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2762 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2763 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2764 return false;
2765 return true;
2766}
2767
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002768bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002769 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2770 const VkRect2D &render_area, uint32_t rect_count,
2771 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002772 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002773 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2774 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002775 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002776 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002777
2778 for (uint32_t j = 0; j < rect_count; j++) {
2779 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002780 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2781 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2782 "the current render pass instance.",
2783 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002784 }
2785
2786 if (image_view_state) {
2787 // The layers specified by a given element of pRects must be contained within every attachment that
2788 // pAttachments refers to
2789 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2790 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2791 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002792 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2793 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2794 "of pAttachment[%d].",
2795 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002796 }
2797 }
2798 }
2799 return skip;
2800}
2801
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002802bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2803 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002804 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002805 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002806 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002807 if (!cb_node) return skip;
2808
2809 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2810 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2811 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002812 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002813
2814 // Validate that attachment is in reference list of active subpass
2815 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002816 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002817 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002818 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002819 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002820 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002821
John Zulauf3a548ef2019-02-01 16:14:07 -07002822 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2823 auto clear_desc = &pAttachments[attachment_index];
2824 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002825
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002826 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002827 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002828 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002829 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002830 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002831 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2832 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2833 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2834 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002835 skip |= LogError(
2836 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2837 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2838 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2839 attachment_index, clear_desc->colorAttachment,
2840 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2841 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002842
John Zulauff2582972019-02-09 14:53:30 -07002843 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2844 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002845 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002846 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2847 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
2848 " subpass %u. colorAttachmentCount=%u",
2849 attachment_index, clear_desc->colorAttachment,
2850 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2851 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002852 }
John Zulauff2582972019-02-09 14:53:30 -07002853 fb_attachment = color_attachment;
2854
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002855 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2856 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2857 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002858 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002859 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002860 }
2861 } else { // Must be depth and/or stencil
2862 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2863 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002864 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002865 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002866 }
2867 if (!subpass_desc->pDepthStencilAttachment ||
2868 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002869 skip |= LogPerformanceWarning(
2870 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002871 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002872 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002873 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002874 }
2875 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002876 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002877 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2878 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002879 }
2880 }
2881 }
2882 return skip;
2883}
2884
2885void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2886 const VkClearAttachment *pAttachments, uint32_t rectCount,
2887 const VkClearRect *pRects) {
2888 auto *cb_node = GetCBState(commandBuffer);
2889 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
2890 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2891 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
2892 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
2893 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2894 const auto clear_desc = &pAttachments[attachment_index];
2895 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2896 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
2897 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
2898 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2899 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2900 subpass_desc->pDepthStencilAttachment) {
2901 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
2902 }
2903 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002904 if (!clear_rect_copy) {
2905 // We need a copy of the clear rectangles that will persist until the last lambda executes
2906 // but we want to create it as lazily as possible
2907 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002908 }
John Zulauf441558b2019-08-12 11:47:39 -06002909 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2910 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002911 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06002912 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002913 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06002914 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002915 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2916 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002917 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2918 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002919 return skip;
2920 };
2921 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002922 }
2923 }
2924 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002925}
2926
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002927bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2928 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002929 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002930 const auto *cb_node = GetCBState(commandBuffer);
2931 const auto *src_image_state = GetImageState(srcImage);
2932 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002933
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002934 bool skip = false;
2935 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002936 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2937 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002938 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002939 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002940 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2941 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002942 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2943 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002944
Cort Stratton7df30962018-05-17 19:45:57 -07002945 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002946 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002947 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002948 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2949 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2950 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002951 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002952 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2953 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002954 // For each region, the number of layers in the image subresource should not be zero
2955 // For each region, src and dest image aspect must be color only
2956 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002957 skip |=
2958 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2959 skip |=
2960 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002961 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002962 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2963 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002964 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002965 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2966 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002967 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2968 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2969 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2970 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2971 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002972 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2973 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002974 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002975 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2976 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002977
2978 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002979 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002980 skip |= LogError(
2981 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002982 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002983 }
Cort Stratton7df30962018-05-17 19:45:57 -07002984 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002985 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2986 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2987 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002988 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002989 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002990 }
2991 }
2992
2993 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2994 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002995 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002996 }
2997 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2998 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002999 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003000 }
3001 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3002 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003003 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003004 }
3005 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3006 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003007 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003008 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003009 } else {
3010 assert(0);
3011 }
3012 return skip;
3013}
3014
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003015bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3016 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003017 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003018 const auto *cb_node = GetCBState(commandBuffer);
3019 const auto *src_image_state = GetImageState(srcImage);
3020 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003021
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003022 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003023 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003024 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003025 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003026 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003027 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003028 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003029 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003030 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003031 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3032 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003033 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003034 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3035 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003036 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003037 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3038 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003039 skip |=
3040 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003041 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3042 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003043 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003044 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003045 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003046 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003047
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003048 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003049
Dave Houlton33c2d252017-06-09 17:08:32 -06003050 VkFormat src_format = src_image_state->createInfo.format;
3051 VkFormat dst_format = dst_image_state->createInfo.format;
3052 VkImageType src_type = src_image_state->createInfo.imageType;
3053 VkImageType dst_type = dst_image_state->createInfo.imageType;
3054
Cort Stratton186b1a22018-05-01 20:18:06 -04003055 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003056 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003057 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3058 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003059 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003060 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3061 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3062 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003063 }
3064
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003065 if (FormatRequiresYcbcrConversion(src_format)) {
3066 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3067 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3068 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3069 string_VkFormat(src_format));
3070 }
3071
3072 if (FormatRequiresYcbcrConversion(dst_format)) {
3073 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3074 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3075 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3076 string_VkFormat(dst_format));
3077 }
3078
Dave Houlton33c2d252017-06-09 17:08:32 -06003079 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003080 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3081 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003082 }
3083
Dave Houlton33c2d252017-06-09 17:08:32 -06003084 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3085 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003086 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00228",
3087 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003088 }
3089
3090 // Validate consistency for unsigned formats
3091 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3092 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003093 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003094 << "the other one must also have unsigned integer format. "
3095 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003096 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003097 }
3098
3099 // Validate consistency for signed formats
3100 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3101 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003102 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003103 << "the other one must also have signed integer format. "
3104 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003105 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003106 }
3107
3108 // Validate filter for Depth/Stencil formats
3109 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3110 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003111 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003112 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003113 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003114 }
3115
3116 // Validate aspect bits and formats for depth/stencil images
3117 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3118 if (src_format != dst_format) {
3119 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003120 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003121 << "stencil, the other one must have exactly the same format. "
3122 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3123 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003124 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003125 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003126 } // Depth or Stencil
3127
3128 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003129 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003130 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003131 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3132 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3133 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003134 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003135 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3136 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003137 for (uint32_t i = 0; i < regionCount; i++) {
3138 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003139 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003140 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003141 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3142 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003143 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003144 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3145 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003146 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3147 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3148 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003149 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003150 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003151 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003152 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003153 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3154 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003155 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003156 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3157 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003158 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003159 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3160 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003161 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003162 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003163 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003164 }
Dave Houlton48989f32017-05-26 15:01:46 -06003165 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3166 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003167 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003168 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003169 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003170 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003171
3172 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003173 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003174 skip |= LogError(
3175 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003176 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003177 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003178
Dave Houlton48989f32017-05-26 15:01:46 -06003179 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003180 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3181 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003182 }
Dave Houlton48989f32017-05-26 15:01:46 -06003183
Dave Houlton33c2d252017-06-09 17:08:32 -06003184 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003185 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3186 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3187 "image format %s.",
3188 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003189 }
3190
3191 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003192 skip |= LogError(
3193 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003194 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3195 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003196 }
3197
Dave Houlton48989f32017-05-26 15:01:46 -06003198 // Validate source image offsets
3199 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003200 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003201 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003202 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003203 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3204 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3205 "of (%1d, %1d). These must be (0, 1).",
3206 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003207 }
3208 }
3209
Dave Houlton33c2d252017-06-09 17:08:32 -06003210 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003211 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003212 skip |=
3213 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3214 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3215 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3216 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003217 }
3218 }
3219
Dave Houlton33c2d252017-06-09 17:08:32 -06003220 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003221 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3222 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003223 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003224 skip |= LogError(
3225 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003226 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3227 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003228 }
3229 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3230 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003231 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003232 skip |= LogError(
3233 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003234 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003235 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003236 }
3237 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3238 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003239 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003240 skip |= LogError(
3241 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003242 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3243 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003244 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003245 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003246 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3247 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003248 }
Dave Houlton48989f32017-05-26 15:01:46 -06003249
3250 // Validate dest image offsets
3251 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003252 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003253 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003254 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003255 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3256 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3257 "(%1d, %1d). These must be (0, 1).",
3258 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003259 }
3260 }
3261
Dave Houlton33c2d252017-06-09 17:08:32 -06003262 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003263 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003264 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3265 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3266 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3267 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003268 }
3269 }
3270
Dave Houlton33c2d252017-06-09 17:08:32 -06003271 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003272 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3273 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003274 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003275 skip |= LogError(
3276 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003277 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3278 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003279 }
3280 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3281 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003282 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003283 skip |= LogError(
3284 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003285 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003286 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003287 }
3288 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3289 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003290 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003291 skip |= LogError(
3292 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003293 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3294 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003295 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003296 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003297 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3298 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003299 }
3300
Dave Houlton33c2d252017-06-09 17:08:32 -06003301 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3302 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3303 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003304 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003305 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3306 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3307 "layerCount other than 1.",
3308 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003309 }
3310 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003311 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003312 } else {
3313 assert(0);
3314 }
3315 return skip;
3316}
3317
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003318void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3319 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3320 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003321 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3322 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003323 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003324 auto src_image_state = GetImageState(srcImage);
3325 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003326
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003327 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003328 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003329 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3330 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003331 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003332}
3333
John Zulauf2076e812020-01-08 14:55:54 -07003334GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3335 assert(map);
3336 // This approach allows for a single hash lookup or/create new
3337 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3338 if (inserted.second) {
3339 assert(nullptr == inserted.first->second.get());
3340 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.range_encoder.SubresourceCount());
3341 inserted.first->second.reset(layout_map);
3342 return layout_map;
3343 } else {
3344 assert(nullptr != inserted.first->second.get());
3345 return inserted.first->second.get();
3346 }
3347 return nullptr;
3348}
3349
3350const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3351 auto it = map.find(image);
3352 if (it != map.end()) {
3353 return it->second.get();
3354 }
3355 return nullptr;
3356}
3357
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003358// 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 -07003359bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3360 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003361 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003362 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003363 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003364 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003365 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003366 for (const auto &layout_map_entry : pCB->image_layout_map) {
3367 const auto image = layout_map_entry.first;
3368 const auto *image_state = GetImageState(image);
3369 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003370 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003371 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003372 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003373 if (initial_layout_map.empty()) continue;
3374
3375 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3376 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3377 if (global_map == nullptr) {
3378 global_map = &empty_map;
3379 }
3380
3381 // Note: don't know if it would matter
3382 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3383
3384 auto pos = initial_layout_map.begin();
3385 const auto end = initial_layout_map.end();
3386 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3387 pos->first.begin);
3388 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003389 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003390 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003391 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 -07003392 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003393 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003394 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003395 image_layout = current_layout->pos_B->lower_bound->second;
3396 }
3397 const auto intersected_range = pos->first & current_layout->range;
3398 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3399 // TODO: Set memory invalid which is in mem_tracker currently
3400 } else if (image_layout != initial_layout) {
3401 // Need to look up the inital layout *state* to get a bit more information
3402 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3403 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3404 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3405 if (!matches) {
3406 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
3407 // We can report all the errors for the intersected range directly
3408 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
3409 const auto subresource = image_state->range_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003410 skip |= LogError(
3411 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003412 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003413 "to be in layout %s--instead, current layout is %s.%s",
John Zulauf2076e812020-01-08 14:55:54 -07003414 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
3415 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout),
locke-lunarga344e7c2020-01-02 19:48:53 -07003416 formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003417 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003418 }
3419 }
John Zulauf2076e812020-01-08 14:55:54 -07003420 if (pos->first.includes(intersected_range.end)) {
3421 current_layout.seek(intersected_range.end);
3422 } else {
3423 ++pos;
3424 if (pos != end) {
3425 current_layout.seek(pos->first.begin);
3426 }
3427 }
John Zulauff660ad62019-03-23 07:16:05 -06003428 }
3429
locke-lunargf155ccf2020-02-18 11:34:15 -07003430 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003431 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003432 }
John Zulauff660ad62019-03-23 07:16:05 -06003433
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003434 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003435}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003436
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003437void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003438 for (const auto &layout_map_entry : pCB->image_layout_map) {
3439 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003440 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003441 const auto *image_state = GetImageState(image);
3442 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003443 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3444 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003445 }
3446}
3447
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003448// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003449// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3450// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003451bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3452 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003453 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003454 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003455 const char *vuid;
3456 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3457
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003458 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3459 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003460 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3461 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3462 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003463 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
3464 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3465 string_VkImageLayout(first_layout));
Shannon McPherson3ea65132018-12-05 10:37:39 -07003466 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3467 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003468 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3469 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3470 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003471 }
3472 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003473 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3474 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003475 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003476 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3477 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003478 }
3479 }
3480
3481 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3482 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003483 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003484 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3485 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003486 }
3487 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003488 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003489}
3490
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003491bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3492 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003493 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003494 const char *vuid;
3495 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003496
Jason Ekstranda1906302017-12-03 20:16:32 -08003497 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3498 VkFormat format = pCreateInfo->pAttachments[i].format;
3499 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3500 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3501 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003502 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3503 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3504 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3505 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3506 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003507 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003508 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003509 skip |=
3510 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3511 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3512 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3513 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3514 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003515 }
3516 }
3517 }
3518
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003519 // Track when we're observing the first use of an attachment
3520 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3521 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003522 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003523
3524 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3525 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3526 auto attach_index = subpass.pInputAttachments[j].attachment;
3527 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003528 switch (subpass.pInputAttachments[j].layout) {
3529 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3530 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3531 // These are ideal.
3532 break;
3533
3534 case VK_IMAGE_LAYOUT_GENERAL:
3535 // May not be optimal. TODO: reconsider this warning based on other constraints.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003536 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3537 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
Cort Stratton7547f772017-05-04 15:18:52 -07003538 break;
3539
Tobias Hectorbbb12282018-10-22 15:17:59 +01003540 case VK_IMAGE_LAYOUT_UNDEFINED:
3541 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003542 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003543 skip |= LogError(device, vuid,
3544 "Layout for input attachment reference %u in subpass %u is %s but must be "
3545 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3546 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003547 break;
3548
Piers Daniell9af77cd2019-10-16 13:54:12 -06003549 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3550 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3551 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3552 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003553 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003554 skip |= LogError(
3555 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003556 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3557 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3558 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3559 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3560 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003561 skip |= LogError(
3562 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003563 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3564 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3565 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3566 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3567 } else if ((subpass.pInputAttachments[j].aspectMask &
3568 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3569 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3570 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3571 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3572 const auto *attachment_reference_stencil_layout =
3573 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3574 if (attachment_reference_stencil_layout) {
3575 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3576 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3577 attachment_reference_stencil_layout->stencilLayout ==
3578 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3579 attachment_reference_stencil_layout->stencilLayout ==
3580 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3581 attachment_reference_stencil_layout->stencilLayout ==
3582 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3583 attachment_reference_stencil_layout->stencilLayout ==
3584 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3585 attachment_reference_stencil_layout->stencilLayout ==
3586 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3587 attachment_reference_stencil_layout->stencilLayout ==
3588 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3589 attachment_reference_stencil_layout->stencilLayout ==
3590 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3591 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003592 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3593 "In the attachment reference %u in subpass %u with pNext chain instance "
3594 "VkAttachmentReferenceStencilLayoutKHR"
3595 "the stencilLayout member but must not be "
3596 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3597 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3598 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3599 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3600 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3601 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3602 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3603 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3604 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3605 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003606 }
3607 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003608 skip |= LogError(
3609 device, "VUID-VkAttachmentReference2-attachment-03315",
3610 "When the layout for input attachment reference %u in subpass %u is "
3611 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3612 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3613 "VkAttachmentReferenceStencilLayout instance.",
3614 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003615 }
3616 }
3617 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3618 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3619 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003620 skip |= LogError(
3621 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003622 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3623 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3624 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3625 j, i);
3626 }
3627 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3628 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3629 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003630 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3631 "When the aspectMask for input attachment reference %u in subpass %u is "
3632 "VK_IMAGE_ASPECT_STENCIL_BIT "
3633 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3634 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3635 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003636 }
3637 }
3638 break;
3639
Graeme Leese668a9862018-10-08 10:40:02 +01003640 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3641 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003642 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003643 break;
3644 } else {
3645 // Intentionally fall through to generic error message
3646 }
3647 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003648
Cort Stratton7547f772017-05-04 15:18:52 -07003649 default:
3650 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003651 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3652 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3653 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003654 }
3655
Cort Stratton7547f772017-05-04 15:18:52 -07003656 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003657 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3658 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003659
3660 bool used_as_depth =
3661 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3662 bool used_as_color = false;
3663 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3664 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3665 }
3666 if (!used_as_depth && !used_as_color &&
3667 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003668 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003669 skip |= LogError(device, vuid,
3670 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3671 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003672 }
3673 }
3674 attach_first_use[attach_index] = false;
3675 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003676
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003677 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3678 auto attach_index = subpass.pColorAttachments[j].attachment;
3679 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3680
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003681 // TODO: Need a way to validate shared presentable images here, currently just allowing
3682 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3683 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003684 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003685 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003686 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003687 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3688 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003689 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003690
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003691 case VK_IMAGE_LAYOUT_GENERAL:
3692 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003693 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3694 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003695 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003696
Tobias Hectorbbb12282018-10-22 15:17:59 +01003697 case VK_IMAGE_LAYOUT_UNDEFINED:
3698 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003699 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003700 skip |= LogError(device, vuid,
3701 "Layout for color attachment reference %u in subpass %u is %s but should be "
3702 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3703 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003704 break;
3705
Piers Daniell9af77cd2019-10-16 13:54:12 -06003706 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3707 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3708 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3709 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003710 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003711 skip |= LogError(
3712 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003713 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3714 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3715 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3716 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3717 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003718 skip |= LogError(
3719 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003720 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3721 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3722 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3723 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3724 } else if ((subpass.pColorAttachments[j].aspectMask &
3725 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3726 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3727 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3728 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3729 const auto *attachment_reference_stencil_layout =
3730 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3731 if (attachment_reference_stencil_layout) {
3732 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3733 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3734 attachment_reference_stencil_layout->stencilLayout ==
3735 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3736 attachment_reference_stencil_layout->stencilLayout ==
3737 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3738 attachment_reference_stencil_layout->stencilLayout ==
3739 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3740 attachment_reference_stencil_layout->stencilLayout ==
3741 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3742 attachment_reference_stencil_layout->stencilLayout ==
3743 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3744 attachment_reference_stencil_layout->stencilLayout ==
3745 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3746 attachment_reference_stencil_layout->stencilLayout ==
3747 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3748 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003749 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3750 "In the attachment reference %u in subpass %u with pNext chain instance "
3751 "VkAttachmentReferenceStencilLayoutKHR"
3752 "the stencilLayout member but must not be "
3753 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3754 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3755 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3756 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3757 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3758 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3759 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3760 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3761 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3762 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003763 }
3764 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003765 skip |= LogError(
3766 device, "VUID-VkAttachmentReference2-attachment-03315",
3767 "When the layout for color attachment reference %u in subpass %u is "
3768 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3769 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3770 "VkAttachmentReferenceStencilLayout instance.",
3771 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003772 }
3773 }
3774 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3775 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3776 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003777 skip |= LogError(
3778 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003779 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3780 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3781 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3782 j, i);
3783 }
3784 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3785 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3786 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003787 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3788 "When the aspectMask for color attachment reference %u in subpass %u is "
3789 "VK_IMAGE_ASPECT_STENCIL_BIT "
3790 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3791 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3792 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003793 }
3794 }
3795 break;
3796
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003797 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003798 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3799 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3800 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003801 }
3802
John Zulauf4eee2692019-02-09 16:14:25 -07003803 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3804 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3805 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003806 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003807 skip |= LogError(device, vuid,
3808 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
3809 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3810 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003811 }
3812
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003813 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003814 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3815 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003816 }
3817 attach_first_use[attach_index] = false;
3818 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003819
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003820 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3821 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003822 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3823 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3824 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003825 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003826
Dave Houltona9df0ce2018-02-07 10:51:23 -07003827 case VK_IMAGE_LAYOUT_GENERAL:
3828 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3829 // doing a bunch of transitions.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003830 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3831 "GENERAL layout for depth attachment may not give optimal performance.");
Dave Houltona9df0ce2018-02-07 10:51:23 -07003832 break;
3833
Tobias Hectorbbb12282018-10-22 15:17:59 +01003834 case VK_IMAGE_LAYOUT_UNDEFINED:
3835 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003836 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003837 skip |= LogError(device, vuid,
3838 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3839 "layout or GENERAL.",
3840 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003841 break;
3842
Piers Daniell9af77cd2019-10-16 13:54:12 -06003843 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3844 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3845 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3846 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003847 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003848 skip |= LogError(
3849 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003850 "Layout for depth attachment reference in subpass %u is %s but must not be "
3851 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3852 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3853 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3854 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003855 skip |= LogError(
3856 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003857 "Layout for depth attachment reference in subpass %u is %s but must not be "
3858 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3859 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3860 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3861 } else if ((subpass.pDepthStencilAttachment->aspectMask &
3862 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3863 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3864 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3865 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3866 const auto *attachment_reference_stencil_layout =
3867 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
3868 if (attachment_reference_stencil_layout) {
3869 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3870 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3871 attachment_reference_stencil_layout->stencilLayout ==
3872 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3873 attachment_reference_stencil_layout->stencilLayout ==
3874 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3875 attachment_reference_stencil_layout->stencilLayout ==
3876 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3877 attachment_reference_stencil_layout->stencilLayout ==
3878 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3879 attachment_reference_stencil_layout->stencilLayout ==
3880 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3881 attachment_reference_stencil_layout->stencilLayout ==
3882 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3883 attachment_reference_stencil_layout->stencilLayout ==
3884 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3885 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003886 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3887 "In the attachment reference in subpass %u with pNext chain instance "
3888 "VkAttachmentReferenceStencilLayoutKHR"
3889 "the stencilLayout member but must not be "
3890 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3891 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3892 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3893 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3894 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3895 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3896 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3897 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3898 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3899 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003900 }
3901 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003902 skip |= LogError(
3903 device, "VUID-VkAttachmentReference2-attachment-03315",
3904 "When the layout for depth attachment reference in subpass %u is "
3905 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3906 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3907 "VkAttachmentReferenceStencilLayout instance.",
3908 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003909 }
3910 }
3911 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3912 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3913 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003914 skip |= LogError(
3915 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003916 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3917 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3918 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3919 i);
3920 }
3921 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3922 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3923 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003924 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3925 "When the aspectMask for depth attachment reference in subpass %u is "
3926 "VK_IMAGE_ASPECT_STENCIL_BIT "
3927 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3928 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3929 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003930 }
3931 }
3932 break;
3933
Dave Houltona9df0ce2018-02-07 10:51:23 -07003934 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3935 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003936 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003937 break;
3938 } else {
3939 // Intentionally fall through to generic error message
3940 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003941 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003942
Dave Houltona9df0ce2018-02-07 10:51:23 -07003943 default:
3944 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003945 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3946 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3947 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3948 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003949 }
3950
3951 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3952 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003953 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3954 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003955 }
3956 attach_first_use[attach_index] = false;
3957 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003958 }
3959 return skip;
3960}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003961
Mark Lobodzinski96210742017-02-09 10:33:46 -07003962// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3963// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003964template <typename T1>
3965bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
3966 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
3967 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003968 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003969 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003970 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003971 if (strict) {
3972 correct_usage = ((actual & desired) == desired);
3973 } else {
3974 correct_usage = ((actual & desired) != 0);
3975 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003976
Mark Lobodzinski96210742017-02-09 10:33:46 -07003977 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003978 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003979 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003980 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
3981 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3982 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003983 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003984 skip = LogError(object, msgCode,
3985 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3986 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003987 }
3988 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003989 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003990}
3991
3992// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3993// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003994bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003995 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003996 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06003997 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003998}
3999
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004000bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06004001 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004002 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04004003 bool skip = false;
4004 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
4005 if ((format_properties.linearTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004006 skip |=
4007 LogError(image_state->image, linear_vuid, "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.",
4008 func_name, format_properties.linearTilingFeatures, image_state->createInfo.format,
4009 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004010 }
4011 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
4012 if ((format_properties.optimalTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004013 skip |= LogError(image_state->image, optimal_vuid,
4014 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
4015 format_properties.optimalTilingFeatures, image_state->createInfo.format,
4016 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004017 }
4018 }
4019 return skip;
4020}
4021
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004022bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004023 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004024 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004025 // layerCount must not be zero
4026 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004027 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4028 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004029 }
4030 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4031 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004032 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4033 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004034 }
4035 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4036 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4037 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004038 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4039 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4040 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4041 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004042 }
4043 return skip;
4044}
4045
Mark Lobodzinski96210742017-02-09 10:33:46 -07004046// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4047// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004048bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004049 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004050 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004051 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004052}
4053
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004054bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004055 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004056 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004057
4058 const VkDeviceSize &range = pCreateInfo->range;
4059 if (range != VK_WHOLE_SIZE) {
4060 // Range must be greater than 0
4061 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004062 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
4063 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4064 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4065 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004066 }
4067 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004068 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4069 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004070 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
4071 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4072 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4073 "(%" PRIu32 ").",
4074 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004075 }
4076 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004077 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004078 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
4079 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4080 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4081 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4082 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004083 }
4084 // The sum of range and offset must be less than or equal to the size of buffer
4085 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004086 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
4087 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4088 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4089 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4090 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004091 }
4092 }
4093 return skip;
4094}
4095
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004096bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004097 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004098 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004099 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4100 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004101 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
4102 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4103 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004104 }
4105 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4106 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004107 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
4108 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4109 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004110 }
4111 return skip;
4112}
4113
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004114bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004115 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004116 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004117
Dave Houltond8ed0212018-05-16 17:18:24 -06004118 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004119
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004120 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004121 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4122 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4123 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004124 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004125
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004126 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004127 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4128 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4129 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004130 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004131
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004132 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004133 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4134 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4135 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004136 }
Jeff Bolz87697532019-01-11 22:54:00 -06004137
4138 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4139 if (chained_devaddr_struct) {
4140 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4141 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004142 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4143 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4144 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004145 }
4146 }
4147
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004148 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4149 if (chained_opaqueaddr_struct) {
4150 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4151 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004152 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4153 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4154 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004155 }
4156 }
4157
Shannon McPherson4984e642019-12-05 13:04:34 -07004158 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004159 !enabled_features.core12.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004160 skip |= LogError(
4161 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004162 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4163 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4164 }
4165
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004166 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004167 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4168 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4169 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004170 }
4171
Mark Lobodzinski96210742017-02-09 10:33:46 -07004172 return skip;
4173}
4174
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004175bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004176 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004177 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004178 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004179 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4180 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004181 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004182 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4183 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004184 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004185 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4186 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4187 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004188
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004189 // Buffer view offset must be less than the size of buffer
4190 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004191 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
4192 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4193 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4194 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004195 }
4196
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004197 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004198 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4199 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4200 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004201 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-02749",
4202 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4203 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4204 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004205 }
4206
4207 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4208 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4209 if ((elementSize % 3) == 0) {
4210 elementSize /= 3;
4211 }
4212 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4213 VkDeviceSize alignmentRequirement =
4214 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4215 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4216 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4217 }
4218 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004219 skip |= LogError(
4220 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004221 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4222 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4223 ") must be a multiple of the lesser of "
4224 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4225 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4226 "(%" PRId32
4227 ") is VK_TRUE, the size of a texel of the requested format. "
4228 "If the size of a texel is a multiple of three bytes, then the size of a "
4229 "single component of format is used instead",
4230 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4231 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4232 }
4233 }
4234 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4235 VkDeviceSize alignmentRequirement =
4236 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4237 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4238 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4239 }
4240 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004241 skip |= LogError(
4242 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004243 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4244 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4245 ") must be a multiple of the lesser of "
4246 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4247 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4248 "(%" PRId32
4249 ") is VK_TRUE, the size of a texel of the requested format. "
4250 "If the size of a texel is a multiple of three bytes, then the size of a "
4251 "single component of format is used instead",
4252 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4253 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4254 }
4255 }
4256 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004257
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004258 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004259
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004260 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004261 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004262 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004263}
4264
Mark Lobodzinski602de982017-02-09 11:01:33 -07004265// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004266bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004267 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004268 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004269
Dave Houlton1d2022c2017-03-29 11:43:58 -06004270 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004271 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004272 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 -07004273 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004274 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 -07004275 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004276 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004277 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004278 skip |= LogError(image, vuid,
4279 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4280 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4281 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004282 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004283 skip |= LogError(image, vuid,
4284 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4285 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4286 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004287 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004288 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004289 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004290 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 -07004291 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004292 skip |=
4293 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 -07004294 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004295 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004296 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004297 skip |=
4298 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 -07004299 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004300 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4301 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004302 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004303 } else if (FormatIsMultiplane(format)) {
4304 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4305 if (3 == FormatPlaneCount(format)) {
4306 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4307 }
4308 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004309 skip |=
4310 LogError(image, vuid,
4311 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4312 "set, where n = [0, 1, 2].",
4313 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004314 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004315 }
4316 return skip;
4317}
4318
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004319bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4320 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004321 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4322 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004323 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004324
4325 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004326 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004327 skip |= LogError(image, errorCodes.base_mip_err,
4328 "%s: %s.baseMipLevel (= %" PRIu32
4329 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4330 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004331 }
Petr Kraus4d718682017-05-18 03:38:41 +02004332
Petr Krausffa94af2017-08-08 21:46:02 +02004333 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4334 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004335 skip |= LogError(image, errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004336 } else {
4337 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004338
Petr Krausffa94af2017-08-08 21:46:02 +02004339 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004340 skip |= LogError(image, errorCodes.mip_count_err,
4341 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4342 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4343 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4344 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004345 }
Petr Kraus4d718682017-05-18 03:38:41 +02004346 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004347 }
Petr Kraus4d718682017-05-18 03:38:41 +02004348
4349 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004350 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004351 skip |= LogError(image, errorCodes.base_layer_err,
4352 "%s: %s.baseArrayLayer (= %" PRIu32
4353 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4354 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004355 }
Petr Kraus4d718682017-05-18 03:38:41 +02004356
Petr Krausffa94af2017-08-08 21:46:02 +02004357 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4358 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004359 skip |= LogError(image, errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004360 } else {
4361 const uint64_t necessary_layer_count =
4362 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004363
Petr Krausffa94af2017-08-08 21:46:02 +02004364 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004365 skip |= LogError(image, errorCodes.layer_count_err,
4366 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4367 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4368 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4369 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004370 }
Petr Kraus4d718682017-05-18 03:38:41 +02004371 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004372 }
Petr Kraus4d718682017-05-18 03:38:41 +02004373
Mark Lobodzinski602de982017-02-09 11:01:33 -07004374 return skip;
4375}
4376
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004377bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004378 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004379 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004380 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4381 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4382 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4383
4384 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4385 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4386
4387 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004388 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4389 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004390 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004391 : "VUID-VkImageViewCreateInfo-image-01482")
4392 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4393 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004394 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004395 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4396 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004397
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004398 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004399 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004400 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004401}
4402
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004403bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004404 const VkImageSubresourceRange &subresourceRange,
4405 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004406 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004407 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4408 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4409 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4410 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004411
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004412 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004413 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004414 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004415}
4416
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004417bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004418 const VkImageSubresourceRange &subresourceRange,
4419 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004420 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004421 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4422 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4423 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4424 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004425
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004426 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004427 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4428 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004429}
4430
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004431bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004432 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004433 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004434 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004435 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4436 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4437 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4438 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004439
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004440 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004441 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004442}
4443
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004444bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004445 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004446 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004447 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004448 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004449 skip |=
4450 ValidateImageUsageFlags(image_state,
4451 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4452 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4453 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4454 false, kVUIDUndefined, "vkCreateImageView()",
4455 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4456 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004457 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004458 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004459 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004460 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004461 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004462 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004463
4464 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4465 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004466 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4467 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004468 VkFormat view_format = pCreateInfo->format;
4469 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004470 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004471 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004472
Dave Houltonbd2e2622018-04-10 16:41:14 -06004473 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004474 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004475 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004476 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004477 if (!device_extensions.vk_ext_separate_stencil_usage) {
4478 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004479 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4480 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4481 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004482 }
4483 } else {
4484 const auto image_stencil_struct =
4485 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4486 if (image_stencil_struct == nullptr) {
4487 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004488 skip |= LogError(
4489 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004490 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4491 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4492 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4493 }
4494 } else {
4495 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4496 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4497 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004498 skip |= LogError(
4499 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004500 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4501 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4502 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4503 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4504 }
4505 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4506 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004507 skip |= LogError(
4508 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004509 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4510 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4511 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4512 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4513 }
4514 }
4515 }
4516 }
4517
Dave Houltonbd2e2622018-04-10 16:41:14 -06004518 image_usage = chained_ivuci_struct->usage;
4519 }
4520
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004521 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4522 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004523 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004524 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004525 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004526 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004527 std::stringstream ss;
4528 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004529 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004530 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004531 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004532 }
4533 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004534 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06004535 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4536 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004537 const char *error_vuid;
4538 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4539 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4540 } else if ((device_extensions.vk_khr_maintenance2) &&
4541 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4542 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4543 } else if ((!device_extensions.vk_khr_maintenance2) &&
4544 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4545 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4546 } else {
4547 // both enabled
4548 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4549 }
Dave Houltonc7988072018-04-16 11:46:56 -06004550 std::stringstream ss;
4551 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004552 << " is not in the same format compatibility class as "
4553 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004554 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4555 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004556 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004557 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004558 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004559 }
4560 } else {
4561 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004562 // Unless it is a multi-planar color bit aspect
4563 if ((image_format != view_format) &&
4564 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4565 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4566 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004567 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004568 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004569 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004570 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004571 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004572 }
4573 }
4574
sfricke-samsungd40eda42020-02-09 17:54:31 -08004575 // Validate feature set if using CUBE_ARRAY
4576 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) && (enabled_features.core.imageCubeArray == false)) {
4577 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-viewType-01004",
4578 "vkCreateImageView(): pCreateInfo->viewType can't be VK_IMAGE_VIEW_TYPE_CUBE_ARRAY without "
4579 "enabling the imageCubeArray feature.");
4580 }
4581
Mark Lobodzinski602de982017-02-09 11:01:33 -07004582 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004583 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004584
4585 switch (image_type) {
4586 case VK_IMAGE_TYPE_1D:
4587 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004588 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4589 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4590 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004591 }
4592 break;
4593 case VK_IMAGE_TYPE_2D:
4594 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4595 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4596 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004597 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4598 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4599 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004600 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004601 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4602 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4603 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004604 }
4605 }
4606 break;
4607 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004608 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004609 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4610 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4611 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004612 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004613 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4614 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4615 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004616 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4617 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004618 skip |= LogError(
4619 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4620 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4621 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4622 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4623 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004624 }
4625 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004626 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4627 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4628 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004629 }
4630 }
4631 } else {
4632 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004633 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4634 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4635 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004636 }
4637 }
4638 break;
4639 default:
4640 break;
4641 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004642
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004643 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004644 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004645 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004646 }
4647
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004648 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004649 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4650 : format_properties.optimalTilingFeatures;
4651
4652 if (tiling_features == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004653 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-None-02273",
4654 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4655 "physical device.",
4656 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004657 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004658 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02274",
4659 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4660 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4661 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004662 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004663 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02275",
4664 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4665 "VK_IMAGE_USAGE_STORAGE_BIT.",
4666 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004667 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4668 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004669 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02276",
4670 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4671 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4672 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004673 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4674 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004675 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02277",
4676 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4677 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4678 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
sfricke-samsungd40eda42020-02-09 17:54:31 -08004679 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4680 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4681 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02652",
4682 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4683 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4684 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004685 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004686
Jeff Bolz9af91c52018-09-01 21:53:57 -05004687 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4688 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004689 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4690 "vkCreateImageView() If image was created with usage containing "
4691 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4692 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004693 }
4694 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004695 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4696 "vkCreateImageView() If image was created with usage containing "
4697 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004698 }
4699 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004700 }
4701 return skip;
4702}
4703
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004704bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4705 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004706 bool skip = false;
4707
4708 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4709 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4710 VkDeviceSize src_min = UINT64_MAX;
4711 VkDeviceSize src_max = 0;
4712 VkDeviceSize dst_min = UINT64_MAX;
4713 VkDeviceSize dst_max = 0;
4714
4715 for (uint32_t i = 0; i < regionCount; i++) {
4716 src_min = std::min(src_min, pRegions[i].srcOffset);
4717 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4718 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4719 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4720
4721 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4722 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004723 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
4724 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4725 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4726 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004727 }
4728
4729 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4730 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004731 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
4732 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4733 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4734 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004735 }
4736
4737 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4738 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004739 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
4740 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4741 ") is greater than the source buffer size (%" PRIuLEAST64
4742 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4743 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004744 }
4745
4746 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4747 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004748 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
4749 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4750 ") is greater than the destination buffer size (%" PRIuLEAST64
4751 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4752 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004753 }
4754 }
4755
4756 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4757 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4758 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004759 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
4760 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004761 }
4762 }
4763
4764 return skip;
4765}
4766
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004767bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004768 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004769 const auto cb_node = GetCBState(commandBuffer);
4770 const auto src_buffer_state = GetBufferState(srcBuffer);
4771 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004772
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004773 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004774 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4775 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004776 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004777 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004778 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4779 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004780 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004781 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4782 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004783 skip |=
4784 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4785 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004786 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4787 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004788 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004789 return skip;
4790}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004791
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004792bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004793 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004794 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004795 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004796 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
4797 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004798 } else {
4799 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004800 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
4801 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004802 }
4803 }
4804 return skip;
4805}
4806
Jeff Bolz5c801d12019-10-09 10:38:45 -05004807bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4808 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004809 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004810 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004811
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004812 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004813 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004814 skip |=
4815 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004816 }
4817 return skip;
4818}
4819
Jeff Bolz5c801d12019-10-09 10:38:45 -05004820bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004821 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004822
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004823 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004824 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004825 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004826 }
4827 return skip;
4828}
4829
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004830bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004831 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004832 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004833 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004834 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004835 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004836 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004837 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004838 }
4839 return skip;
4840}
4841
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004842bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004843 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004844 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004845 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004846 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004847 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004848 skip |=
4849 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4850 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004851 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004852 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004853 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4854 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004855 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004856
4857 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004858 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
4859 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
4860 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
4861 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004862 }
4863
4864 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004865 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
4866 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
4867 ") minus dstOffset (0x%" PRIxLEAST64 ").",
4868 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004869 }
4870
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004871 return skip;
4872}
4873
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004874bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
4875 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004876 bool skip = false;
4877
4878 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004879 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4880 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004881 skip |=
4882 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
4883 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
4884 "and 1, respectively.",
4885 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004886 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004887 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004888
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004889 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4890 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004891 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
4892 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
4893 "must be 0 and 1, respectively.",
4894 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004895 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004896 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004897
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004898 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4899 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004900 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
4901 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4902 "For 3D images these must be 0 and 1, respectively.",
4903 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004904 }
4905 }
4906
4907 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004908 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004909 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4910
Dave Houltona585d132019-01-18 13:05:42 -07004911 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004912 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00193",
4913 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
4914 " must be a multiple of this format's texel size (%" PRIu32 ").",
4915 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004916 }
4917
4918 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004919 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004920 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00194",
4921 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4922 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004923 }
4924
4925 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4926 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004927 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004928 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
4929 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4930 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004931 }
4932
4933 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4934 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004935 skip |= LogError(
4936 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004937 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4938 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004939 }
4940
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004941 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004942 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004943 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004944 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 -06004945 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
4946 static_cast<int32_t>(adjusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004947 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
4948 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
4949 "zero or <= image subresource width (%d).",
4950 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004951 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004952 }
4953
4954 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004955 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 -06004956 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
4957 static_cast<int32_t>(adjusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004958 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
4959 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
4960 "zero or <= image subresource height (%d).",
4961 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004962 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004963 }
4964
4965 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004966 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 -06004967 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
4968 static_cast<int32_t>(adjusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004969 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
4970 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
4971 "zero or <= image subresource depth (%d).",
4972 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06004973 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004974 }
4975
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004976 // subresource aspectMask must have exactly 1 bit set
4977 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4978 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4979 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004980 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
4981 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004982 }
4983
4984 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004985 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004986 skip |= LogError(
4987 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004988 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4989 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004990 }
4991
4992 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004993 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004994 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004995
4996 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004997 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004998 skip |= LogError(
4999 image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005000 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5001 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005002 }
5003
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005004 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005005 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005006 skip |= LogError(
5007 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005008 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5009 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005010 }
5011
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005012 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005013 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5014 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5015 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005016 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00205",
5017 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5018 "width & height (%d, %d)..",
5019 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5020 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005021 }
5022
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005023 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07005024 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005025 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005026 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00206",
5027 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5028 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5029 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005030 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005031
5032 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005033 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005034 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005035 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005036 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00207",
5037 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5038 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5039 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5040 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005041 }
5042
5043 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005044 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005045 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005046 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00208",
5047 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5048 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5049 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5050 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005051 }
5052
5053 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005054 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005055 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005056 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00209",
5057 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5058 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5059 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5060 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005061 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005062 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005063
5064 // Checks that apply only to multi-planar format images
5065 if (FormatIsMultiplane(image_state->createInfo.format)) {
5066 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5067 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5068 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005069 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5070 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5071 "format has three planes.",
5072 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005073 }
5074
5075 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5076 if (0 == (pRegions[i].imageSubresource.aspectMask &
5077 (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 -07005078 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5079 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5080 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5081 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005082 }
5083 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005084 }
5085
5086 return skip;
5087}
5088
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005089bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5090 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005091 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005092 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005093
5094 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005095 VkExtent3D extent = pRegions[i].imageExtent;
5096 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005097
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005098 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5099 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005100 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5101 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5102 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005103 }
5104
5105 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5106
5107 // 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 -06005108 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005109 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005110 if (image_extent.width % block_extent.width) {
5111 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5112 }
5113 if (image_extent.height % block_extent.height) {
5114 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5115 }
5116 if (image_extent.depth % block_extent.depth) {
5117 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5118 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005119 }
5120
Dave Houltonfc1a4052017-04-27 14:32:45 -06005121 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005122 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005123 }
5124 }
5125
5126 return skip;
5127}
5128
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005129bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5130 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005131 bool skip = false;
5132
5133 VkDeviceSize buffer_size = buff_state->createInfo.size;
5134
5135 for (uint32_t i = 0; i < regionCount; i++) {
5136 VkExtent3D copy_extent = pRegions[i].imageExtent;
5137
5138 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5139 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005140 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5141 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005142
Tom Cooperb2550c72018-10-15 13:08:41 +01005143 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005144 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005145 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005146 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5147 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5148
5149 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5150 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5151 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005152 }
5153
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005154 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5155 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5156 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005157 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005158 } else {
5159 // Calculate buffer offset of final copied byte, + 1.
5160 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5161 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5162 max_buffer_offset *= unit_size; // convert to bytes
5163 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005164
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005165 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005166 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5167 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005168 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005169 }
5170 }
5171
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005172 return skip;
5173}
5174
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005175bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005176 VkBuffer dstBuffer, uint32_t regionCount,
5177 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005178 const auto cb_node = GetCBState(commandBuffer);
5179 const auto src_image_state = GetImageState(srcImage);
5180 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005181
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005182 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005183
5184 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005185 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005186
5187 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005188 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005189
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005190 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005191
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005192 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005193 skip |=
5194 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5195 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5196 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005197 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005198 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005199 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005200 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005201 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005202
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005203 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005204 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005205 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5206 skip |=
5207 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005208
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005209 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005210 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005211 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5212 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005213 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005214 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5215 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005216 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005217 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5218 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005219 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005220 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005221 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005222 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005223 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5224 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5225 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005226 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005227 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005228 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005229 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005230 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5231 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005232 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5233 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5234 skip |=
5235 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5236 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5237 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005238 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5239 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005240 }
5241 return skip;
5242}
5243
John Zulauf1686f232019-07-09 16:27:11 -06005244void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5245 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5246 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5247
5248 auto cb_node = GetCBState(commandBuffer);
5249 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005250 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005251 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005252 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005253 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005254}
5255
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005256bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5257 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005258 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005259 const auto cb_node = GetCBState(commandBuffer);
5260 const auto src_buffer_state = GetBufferState(srcBuffer);
5261 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005262
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005263 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005264
5265 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005266 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005267
5268 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005269 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005270 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005271 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005272 skip |=
5273 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5274 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5275 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005276 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005277 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005278 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005279 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005280 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005281 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005282 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005283 skip |=
5284 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5285 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005286 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005287 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5288 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005289 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005290 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5291 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005292 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005293 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5294 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005295 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005296 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005297 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005298 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005299 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5300 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5301 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005302 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005303 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005304 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005305 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005306 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5307 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005308 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5309 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5310 skip |=
5311 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5312 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5313 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005314 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5315 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005316 }
5317 return skip;
5318}
5319
John Zulauf1686f232019-07-09 16:27:11 -06005320void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5321 VkImageLayout dstImageLayout, uint32_t regionCount,
5322 const VkBufferImageCopy *pRegions) {
5323 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5324
5325 auto cb_node = GetCBState(commandBuffer);
5326 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005327 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005328 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005329 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005330 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005331}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005332
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005333bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005334 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005335 bool skip = false;
5336 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5337
Dave Houlton1d960ff2018-01-19 12:17:05 -07005338 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005339 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5340 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5341 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005342 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5343 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005344 }
5345
John Zulaufa26d3c82019-08-14 16:09:08 -06005346 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005347 if (!image_entry) {
5348 return skip;
5349 }
5350
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005351 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5352 if (device_extensions.vk_ext_image_drm_format_modifier) {
5353 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5354 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005355 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5356 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5357 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005358 }
5359 } else {
5360 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005361 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5362 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005363 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005364 }
5365
Dave Houlton1d960ff2018-01-19 12:17:05 -07005366 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005367 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005368 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5369 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5370 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005371 }
5372
Dave Houlton1d960ff2018-01-19 12:17:05 -07005373 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005374 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005375 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5376 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5377 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005378 }
5379
Dave Houlton1d960ff2018-01-19 12:17:05 -07005380 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005381 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005382 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5383 if (FormatIsMultiplane(img_format)) {
5384 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5385 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5386 if (FormatPlaneCount(img_format) > 2u) {
5387 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5388 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5389 }
5390 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005391 skip |= LogError(image, vuid,
5392 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5393 ") must be a single-plane specifier flag.",
5394 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005395 }
5396 } else if (FormatIsColor(img_format)) {
5397 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005398 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5399 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5400 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005401 }
5402 } else if (FormatIsDepthOrStencil(img_format)) {
5403 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5404 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005405 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005406 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5407 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5408 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5409 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005410 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5411 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5412 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005413 }
5414 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005415
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005416 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005417 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005418 }
5419
Mike Weiblen672b58b2017-02-21 14:32:53 -07005420 return skip;
5421}