blob: 5b4c22d20a793065e4928e470c6168d8ad70b8a4 [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),
John Zulauff660ad62019-03-23 07:16:05 -060077 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -070078 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -060079 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -070080 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -060081 create_from_swapchain(VK_NULL_HANDLE),
82 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -060083 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -070084 range_encoder(full_range),
sfricke-samsung71bc6572020-04-29 15:49:43 -070085 disjoint(false),
86 plane0_memory_requirements_checked(false),
87 plane1_memory_requirements_checked(false),
88 plane2_memory_requirements_checked(false),
unknown08c57af2019-06-21 16:33:35 -060089 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060090 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
91 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
92 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
93 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
94 }
95 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
96 }
97
98 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
99 sparse = true;
100 }
Locked8af3732019-05-10 09:47:56 -0600101
sfricke-samsunge2441192019-11-06 14:07:57 -0800102 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
103 if (externalMemoryInfo) {
104 external_memory_handle = externalMemoryInfo->handleTypes;
105 }
John Zulauff660ad62019-03-23 07:16:05 -0600106}
107
unknown2c877272019-07-11 12:56:50 -0600108bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
109 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
110 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
111 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
112 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
113 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
114 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600115 return is_equal &&
116 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600117}
118
Jeff Bolz82f854d2019-09-17 14:56:47 -0500119// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
120bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
121 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
122 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
123 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
124 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
125 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600126 is_compatible = is_compatible &&
127 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
128 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500129
130 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
131 createInfo.extent.height <= other_createInfo.extent.height &&
132 createInfo.extent.depth <= other_createInfo.extent.depth &&
133 createInfo.arrayLayers <= other_createInfo.arrayLayers;
134 return is_compatible;
135}
136
unknown2c877272019-07-11 12:56:50 -0600137bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700138 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
139 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
140 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700141 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
142 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600143 IsCreateInfoEqual(other_image_state->createInfo)) {
144 return true;
145 }
unknowne1661522019-07-11 13:04:18 -0600146 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
147 return true;
148 }
unknown2c877272019-07-11 12:56:50 -0600149 return false;
150}
151
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500152IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
153 : image_view(iv),
154 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700155 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
156 range_generator(im->range_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500157 samplerConversion(VK_NULL_HANDLE),
158 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600159 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
160 if (conversionInfo) samplerConversion = conversionInfo->conversion;
161 if (image_state) {
162 // A light normalization of the createInfo range
163 auto &sub_res_range = create_info.subresourceRange;
164 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
165 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
166
167 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700168 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500169 samples = image_state->createInfo.samples;
170 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600171 }
172}
173
Dave Houltond9611312018-11-19 17:03:36 -0700174uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
175 // uint cast applies floor()
176 return 1u + (uint32_t)log2(std::max({height, width, depth}));
177}
178
179uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
180
181uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
182
John Zulaufb58415b2019-12-09 15:02:32 -0700183static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
184 const VkImageSubresourceRange &range) {
John Zulauff660ad62019-03-23 07:16:05 -0600185 VkImageSubresourceRange norm = range;
186 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
187
188 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
189 // <arrayLayers> can potentially alias.
190 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
191 ? image_create_info.extent.depth
192 : image_create_info.arrayLayers;
193 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
194
195 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
196 VkImageAspectFlags &aspect_mask = norm.aspectMask;
197 if (FormatIsMultiplane(image_create_info.format)) {
198 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
199 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
200 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
201 if (FormatPlaneCount(image_create_info.format) > 2) {
202 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
203 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700204 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700205 }
John Zulauff660ad62019-03-23 07:16:05 -0600206 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700207}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700208
John Zulaufb58415b2019-12-09 15:02:32 -0700209VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
210 const VkImageCreateInfo &image_create_info = image_state.createInfo;
211 return NormalizeSubresourceRange(image_create_info, range);
212}
213
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500214bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700215 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700216 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700217
John Zulauf2076e812020-01-08 14:55:54 -0700218 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
219 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700220 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
221 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
222
John Zulauf2076e812020-01-08 14:55:54 -0700223 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
224
225 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
226 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700227 return false;
228 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700229
John Zulauf2076e812020-01-08 14:55:54 -0700230 for (auto entry : *layout_range_map) {
231 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700232 }
233 return true;
234}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700235
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600236// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600237void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600238 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
239 VkImageLayout expected_layout) {
240 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
241 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600242 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600243 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700244 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700245 for (const auto &image : image_state.aliasing_images) {
246 auto alias_state = GetImageState(image);
247 // The map state of the aliases should all be in sync, so no need to check the return value
248 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
249 assert(subresource_map);
250 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
251 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700252}
John Zulauff660ad62019-03-23 07:16:05 -0600253
254// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600255void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600256 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500257 return;
258 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500259 IMAGE_STATE *image_state = view_state.image_state.get();
260 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700261 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700262 for (const auto &image : image_state->aliasing_images) {
263 image_state = GetImageState(image);
264 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
265 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
266 }
John Zulauff660ad62019-03-23 07:16:05 -0600267}
268
269// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600270void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600271 const VkImageSubresourceRange &range, VkImageLayout layout) {
272 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
273 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600274 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700275 for (const auto &image : image_state.aliasing_images) {
276 auto alias_state = GetImageState(image);
277 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
278 assert(subresource_map);
279 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
280 }
John Zulauff660ad62019-03-23 07:16:05 -0600281}
282
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600283void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600284 VkImageLayout layout) {
285 const IMAGE_STATE *image_state = GetImageState(image);
286 if (!image_state) return;
287 SetImageInitialLayout(cb_node, *image_state, range, layout);
288};
289
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600290void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600291 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
292 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600293}
Dave Houltonddd65c52018-05-08 14:58:01 -0600294
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600295// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700296void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
297 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500298 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600299
John Zulauff660ad62019-03-23 07:16:05 -0600300 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600301 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
302 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600303 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 -0600304 sub_range.baseArrayLayer = 0;
305 sub_range.layerCount = image_state->createInfo.extent.depth;
306 }
307
Piers Daniell4fde9b72019-11-27 16:19:46 -0700308 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
309 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
310 SetImageLayout(cb_node, *image_state, sub_range, layout);
311 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
312 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
313 } else {
314 SetImageLayout(cb_node, *image_state, sub_range, layout);
315 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600316}
317
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700318bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
319 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700320 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600321 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100322 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700323 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100324 const char *vuid;
325 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
326
327 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600328 LogObjectList objlist(image);
329 objlist.add(renderpass);
330 objlist.add(framebuffer);
331 objlist.add(image_view);
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;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200340 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
341 if (stencil_usage_info) {
342 image_usage |= stencil_usage_info->stencilUsage;
343 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100344
345 // Check for layouts that mismatch image usages in the framebuffer
346 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800347 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600348 LogObjectList objlist(image);
349 objlist.add(renderpass);
350 objlist.add(framebuffer);
351 objlist.add(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100352 skip |=
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600353 LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700354 "Layout/usage mismatch for attachment %u in %s"
355 " - the %s is %s but the image attached to %s via %s"
356 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
357 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
358 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100359 }
360
361 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
362 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800363 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600364 LogObjectList objlist(image);
365 objlist.add(renderpass);
366 objlist.add(framebuffer);
367 objlist.add(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100368 skip |=
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600369 LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700370 "Layout/usage mismatch for attachment %u in %s"
371 " - the %s is %s but the image attached to %s via %s"
372 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
373 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
374 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100375 }
376
377 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800378 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600379 LogObjectList objlist(image);
380 objlist.add(renderpass);
381 objlist.add(framebuffer);
382 objlist.add(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100383 skip |=
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600384 LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700385 "Layout/usage mismatch for attachment %u in %s"
386 " - the %s is %s but the image attached to %s via %s"
387 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
388 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
389 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100390 }
391
392 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800393 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600394 LogObjectList objlist(image);
395 objlist.add(renderpass);
396 objlist.add(framebuffer);
397 objlist.add(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100398 skip |=
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600399 LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700400 "Layout/usage mismatch for attachment %u in %s"
401 " - the %s is %s but the image attached to %s via %s"
402 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
403 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
404 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100405 }
406
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600407 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100408 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
409 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
410 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
411 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
412 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800413 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600414 LogObjectList objlist(image);
415 objlist.add(renderpass);
416 objlist.add(framebuffer);
417 objlist.add(image_view);
418 skip |= LogError(objlist, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700419 "Layout/usage mismatch for attachment %u in %s"
420 " - the %s is %s but the image attached to %s via %s"
421 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
422 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
423 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
424 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100425 }
426 } else {
427 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
428 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
429 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
430 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600431 LogObjectList objlist(image);
432 objlist.add(renderpass);
433 objlist.add(framebuffer);
434 objlist.add(image_view);
435 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700436 "Layout/usage mismatch for attachment %u in %s"
437 " - the %s is %s but the image attached to %s via %s"
438 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
439 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
440 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
441 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100442 }
443 }
444 return skip;
445}
446
John Zulauf17a01bb2019-08-09 16:41:19 -0600447bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700448 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600449 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600450 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700451 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700452 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100453 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100454
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700455 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100456 auto framebuffer = framebuffer_state->framebuffer;
457
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700458 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700459 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
460 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700461 }
John Zulauf8e308292018-09-21 11:34:37 -0600462
Tobias Hectorc9057422019-07-23 12:15:52 +0100463 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
464 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
465 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100466 }
467
Tobias Hectorc9057422019-07-23 12:15:52 +0100468 if (attachments != nullptr) {
469 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
470 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
471 auto image_view = attachments[i];
472 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100473
Tobias Hectorc9057422019-07-23 12:15:52 +0100474 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600475 LogObjectList objlist(pRenderPassBegin->renderPass);
476 objlist.add(framebuffer_state->framebuffer);
477 objlist.add(image_view);
478 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700479 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
480 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
481 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100482 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100483 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100484
485 const VkImage image = view_state->create_info.image;
486 const IMAGE_STATE *image_state = GetImageState(image);
487
488 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600489 LogObjectList objlist(pRenderPassBegin->renderPass);
490 objlist.add(framebuffer_state->framebuffer);
491 objlist.add(image_view);
492 objlist.add(image);
493 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700494 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
495 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
496 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100497 continue;
498 }
499 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
500 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
501
Piers Daniell7f894f62020-01-09 16:33:48 -0700502 // Default to expecting stencil in the same layout.
503 auto attachment_stencil_initial_layout = attachment_initial_layout;
504
505 // If a separate layout is specified, look for that.
506 const auto *attachment_description_stencil_layout =
507 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
508 if (attachment_description_stencil_layout) {
509 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
510 }
511
Tobias Hectorc9057422019-07-23 12:15:52 +0100512 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
513 // in common with the non-const version.)
514 const ImageSubresourceLayoutMap *subresource_map =
515 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
516
517 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
518 LayoutUseCheckAndMessage layout_check(subresource_map);
519 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700520 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
521 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
522 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700523
John Zulauf5e617452019-11-19 14:44:16 -0700524 // Allow for differing depth and stencil layouts
525 VkImageLayout check_layout = attachment_initial_layout;
526 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
527
528 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700529 subres_skip |= LogError(
530 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700531 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
532 "and the %s layout of the attachment is %s. The layouts must match, or the render "
533 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700534 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100535 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700536 }
John Zulauf5e617452019-11-19 14:44:16 -0700537
Tobias Hectorc9057422019-07-23 12:15:52 +0100538 skip |= subres_skip;
539 }
540
541 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
542 framebuffer, render_pass, i, "initial layout");
543
544 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
545 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100546 }
547
Tobias Hectorc9057422019-07-23 12:15:52 +0100548 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
549 auto &subpass = pRenderPassInfo->pSubpasses[j];
550 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
551 auto &attachment_ref = subpass.pInputAttachments[k];
552 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
553 auto image_view = attachments[attachment_ref.attachment];
554 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100555
Tobias Hectorc9057422019-07-23 12:15:52 +0100556 if (view_state) {
557 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700558 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
559 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100560 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100561 }
562 }
563 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100564
Tobias Hectorc9057422019-07-23 12:15:52 +0100565 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
566 auto &attachment_ref = subpass.pColorAttachments[k];
567 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
568 auto image_view = attachments[attachment_ref.attachment];
569 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100570
Tobias Hectorc9057422019-07-23 12:15:52 +0100571 if (view_state) {
572 auto image = view_state->create_info.image;
573 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
574 framebuffer, render_pass, attachment_ref.attachment,
575 "color attachment layout");
576 if (subpass.pResolveAttachments) {
577 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
578 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
579 attachment_ref.attachment, "resolve attachment layout");
580 }
581 }
582 }
583 }
584
585 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
586 auto &attachment_ref = *subpass.pDepthStencilAttachment;
587 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
588 auto image_view = attachments[attachment_ref.attachment];
589 auto view_state = GetImageViewState(image_view);
590
591 if (view_state) {
592 auto image = view_state->create_info.image;
593 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
594 framebuffer, render_pass, attachment_ref.attachment,
595 "input attachment layout");
596 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100597 }
598 }
599 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700600 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600601 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700602}
603
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600604void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700605 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700606 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700607 IMAGE_VIEW_STATE *image_view = nullptr;
608 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
609 const auto attachment_info =
610 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
611 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
612 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300613 image_view = GetAttachmentImageViewState(pCB, pFramebuffer, ref.attachment);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700614 }
John Zulauf8e308292018-09-21 11:34:37 -0600615 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700616 VkImageLayout stencil_layout = kInvalidLayout;
617 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
618 if (attachment_reference_stencil_layout) {
619 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
620 }
621
622 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600623 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700624 }
625}
626
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600627void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
628 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700629 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700630
631 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700632 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700633 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700634 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700635 }
636 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700637 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700638 }
639 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700640 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700641 }
642 }
643}
644
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700645// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
646// 1. Transition into initialLayout state
647// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600648void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700649 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700650 // First transition into initialLayout
651 auto const rpci = render_pass_state->createInfo.ptr();
652 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700653 IMAGE_VIEW_STATE *view_state = nullptr;
654 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
655 const auto attachment_info =
656 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
657 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
658 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300659 view_state = GetAttachmentImageViewState(cb_state, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700660 }
John Zulauf8e308292018-09-21 11:34:37 -0600661 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700662 VkImageLayout stencil_layout = kInvalidLayout;
663 const auto *attachment_description_stencil_layout =
664 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
665 if (attachment_description_stencil_layout) {
666 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
667 }
668
669 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600670 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700671 }
672 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700673 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700674}
675
Dave Houlton10b39482017-03-16 13:18:15 -0600676bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600677 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600678 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600679 }
680 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600681 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600682 }
683 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600684 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600685 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700686 if (0 !=
687 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
688 if (FormatPlaneCount(format) == 1) return false;
689 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600690 return true;
691}
692
Mike Weiblen62d08a32017-03-07 22:18:27 -0700693// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200694bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
695 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600696 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700697 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200698 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600699 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700700
701 switch (layout) {
702 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
703 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600704 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700705 }
706 break;
707 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
708 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600709 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700710 }
711 break;
712 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
713 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600714 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700715 }
716 break;
717 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
718 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600719 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700720 }
721 break;
722 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
723 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600724 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700725 }
726 break;
727 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
728 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600729 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700730 }
731 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600732 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500733 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
734 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
735 }
736 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700737 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
738 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
739 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
740 }
741 break;
742 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
743 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
744 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
745 }
746 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700747 default:
748 // Other VkImageLayout values do not have VUs defined in this context.
749 break;
750 }
751
Dave Houlton8e9f6542018-05-18 12:18:22 -0600752 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700753 skip |= LogError(img_barrier.image, msg_code,
754 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
755 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
756 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700757 }
758 return skip;
759}
760
761// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600762bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
763 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700764 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700765
Petr Krausad0096a2019-08-09 18:35:04 +0200766 // Scoreboard for checking for duplicate and inconsistent barriers to images
767 struct ImageBarrierScoreboardEntry {
768 uint32_t index;
769 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
770 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
771 const VkImageMemoryBarrier *barrier;
772 };
773 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
774 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
775
John Zulauf463c51e2018-05-31 13:29:20 -0600776 // Scoreboard for duplicate layout transition barriers within the list
777 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
778 ImageBarrierScoreboardImageMap layout_transitions;
779
Mike Weiblen62d08a32017-03-07 22:18:27 -0700780 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200781 const auto &img_barrier = pImageMemoryBarriers[i];
782 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700783
John Zulauf463c51e2018-05-31 13:29:20 -0600784 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
785 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
786 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200787 if (img_barrier.oldLayout != img_barrier.newLayout) {
788 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
789 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600790 if (image_it != layout_transitions.end()) {
791 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200792 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600793 if (subres_it != subres_map.end()) {
794 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200795 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
796 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
797 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700798 skip = LogError(
799 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200800 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600801 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
802 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200803 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
804 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
805 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600806 }
807 entry = new_entry;
808 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200809 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600810 }
811 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200812 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600813 }
814 }
815
Petr Krausad0096a2019-08-09 18:35:04 +0200816 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600817 if (image_state) {
818 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200819 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
820 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600821
822 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
823 if (image_state->layout_locked) {
824 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700825 skip |= LogError(
826 img_barrier.image, 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600827 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600828 " 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 +0200829 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
830 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600831 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600832
John Zulaufa4472282019-08-22 14:44:34 -0600833 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700834 const VkFormat image_format = image_create_info.format;
835 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600836 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700837 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700838 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600839 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
840 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700841 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
842 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
843 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
844 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700845 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600846 }
847 } else {
848 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
849 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -0700850 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
851 ? "VUID-VkImageMemoryBarrier-image-03320"
852 : "VUID-VkImageMemoryBarrier-image-01207";
853 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700854 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
855 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
856 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700857 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600858 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700859 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700860 }
John Zulauff660ad62019-03-23 07:16:05 -0600861
Petr Krausad0096a2019-08-09 18:35:04 +0200862 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
863 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600864 // TODO: Set memory invalid which is in mem_tracker currently
865 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
866 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600867 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600868 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600869 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200870 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700871 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
872 const auto &value = *pos;
873 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700874 subres_skip = LogError(
875 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
John Zulauf5e617452019-11-19 14:44:16 -0700876 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
877 "%s layout is %s.",
878 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
879 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
880 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600881 }
John Zulauf5e617452019-11-19 14:44:16 -0700882 }
John Zulauff660ad62019-03-23 07:16:05 -0600883 skip |= subres_skip;
884 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700885
886 // checks color format and (single-plane or non-disjoint)
887 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
888 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700889 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700890 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
891 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
892 ? "VUID-VkImageMemoryBarrier-image-01671"
893 : "VUID-VkImageMemoryBarrier-image-02902";
894 skip |= LogError(img_barrier.image, vuid,
895 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
896 "but its aspectMask is 0x%" PRIx32 ".",
897 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
898 string_VkFormat(image_format), aspect_mask);
899 }
900 }
901
902 VkImageAspectFlags valid_disjoint_mask =
903 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
sfricke-samsung71bc6572020-04-29 15:49:43 -0700904 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700905 ((aspect_mask & valid_disjoint_mask) == 0)) {
906 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
907 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
908 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
909 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
910 string_VkFormat(image_format), aspect_mask);
911 }
912
913 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
914 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
915 "%s: Image barrier %s references %s of format %s has only two planes but included "
916 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
917 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
918 string_VkFormat(image_format), aspect_mask);
919 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700920 }
921 }
922 return skip;
923}
924
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600925bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200926 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700927
Jeff Bolz6835fda2019-10-06 00:15:34 -0500928 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200929 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700930}
931
John Zulauf6b4aae82018-05-09 13:03:36 -0600932template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600933bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
934 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600935 using BarrierRecord = QFOTransferBarrier<Barrier>;
936 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500937 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600938 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
939 const char *barrier_name = BarrierRecord::BarrierName();
940 const char *handle_name = BarrierRecord::HandleName();
941 const char *transfer_type = nullptr;
942 for (uint32_t b = 0; b < barrier_count; b++) {
943 if (!IsTransferOp(&barriers[b])) continue;
944 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700945 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600946 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600947 const auto found = barrier_sets.release.find(barriers[b]);
948 if (found != barrier_sets.release.cend()) {
949 barrier_record = &(*found);
950 transfer_type = "releasing";
951 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600952 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600953 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600954 const auto found = barrier_sets.acquire.find(barriers[b]);
955 if (found != barrier_sets.acquire.cend()) {
956 barrier_record = &(*found);
957 transfer_type = "acquiring";
958 }
959 }
960 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700961 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
962 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
963 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
964 func_name, barrier_name, b, transfer_type, handle_name,
965 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
966 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600967 }
968 }
969 return skip;
970}
971
John Zulaufa4472282019-08-22 14:44:34 -0600972VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
973 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
974}
975
976const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
977 return device_state.GetImageState(barrier.image);
978}
979
980VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
981 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
982}
983
984const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
985 return device_state.GetBufferState(barrier.buffer);
986}
987
988VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
989
John Zulauf6b4aae82018-05-09 13:03:36 -0600990template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600991void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
992 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500993 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600994 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
995 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600996 auto &barrier = barriers[b];
997 if (IsTransferOp(&barrier)) {
998 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600999 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001000 barrier_sets.release.emplace(barrier);
1001 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001002 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001003 barrier_sets.acquire.emplace(barrier);
1004 }
1005 }
1006
1007 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1008 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1009 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1010 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1011 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1012 auto handle_state = BarrierHandleState(*this, barrier);
1013 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1014 if (!mode_concurrent) {
1015 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001016 cb_state->queue_submit_functions.emplace_back(
1017 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1018 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1019 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1020 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001021 });
1022 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001023 }
1024 }
1025}
1026
John Zulaufa4472282019-08-22 14:44:34 -06001027bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001028 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001029 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001030 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001031 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001032 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1033 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001034 return skip;
1035}
1036
John Zulaufa4472282019-08-22 14:44:34 -06001037void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1038 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1039 const VkImageMemoryBarrier *pImageMemBarriers) {
1040 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1041 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001042}
1043
1044template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001045bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001046 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001047 // Record to the scoreboard or report that we have a duplication
1048 bool skip = false;
1049 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1050 if (!inserted.second && inserted.first->second != cb_state) {
1051 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001052 LogObjectList objlist(cb_state->commandBuffer);
1053 objlist.add(barrier.handle);
1054 objlist.add(inserted.first->second->commandBuffer);
1055 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001056 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1057 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1058 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1059 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1060 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001061 }
1062 return skip;
1063}
1064
1065template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001066bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1067 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001068 using BarrierRecord = QFOTransferBarrier<Barrier>;
1069 using TypeTag = typename BarrierRecord::Tag;
1070 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001071 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001072 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001073 const char *barrier_name = BarrierRecord::BarrierName();
1074 const char *handle_name = BarrierRecord::HandleName();
1075 // No release should have an extant duplicate (WARNING)
1076 for (const auto &release : cb_barriers.release) {
1077 // Check the global pending release barriers
1078 const auto set_it = global_release_barriers.find(release.handle);
1079 if (set_it != global_release_barriers.cend()) {
1080 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1081 const auto found = set_for_handle.find(release);
1082 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001083 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1084 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1085 " to dstQueueFamilyIndex %" PRIu32
1086 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1087 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1088 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001089 }
1090 }
1091 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1092 }
1093 // Each acquire must have a matching release (ERROR)
1094 for (const auto &acquire : cb_barriers.acquire) {
1095 const auto set_it = global_release_barriers.find(acquire.handle);
1096 bool matching_release_found = false;
1097 if (set_it != global_release_barriers.cend()) {
1098 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1099 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1100 }
1101 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001102 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1103 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1104 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1105 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1106 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001107 }
1108 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1109 }
1110 return skip;
1111}
1112
John Zulauf3b04ebd2019-07-18 14:08:11 -06001113bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001114 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001115 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001116 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001117 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1118 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001119 return skip;
1120}
1121
1122template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001123void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001124 using BarrierRecord = QFOTransferBarrier<Barrier>;
1125 using TypeTag = typename BarrierRecord::Tag;
1126 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001127 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001128
1129 // Add release barriers from this submit to the global map
1130 for (const auto &release : cb_barriers.release) {
1131 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1132 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1133 global_release_barriers[release.handle].insert(release);
1134 }
1135
1136 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1137 for (const auto &acquire : cb_barriers.acquire) {
1138 // NOTE: We're not using [] because we don't want to create entries for missing releases
1139 auto set_it = global_release_barriers.find(acquire.handle);
1140 if (set_it != global_release_barriers.end()) {
1141 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1142 set_for_handle.erase(acquire);
1143 if (set_for_handle.size() == 0) { // Clean up empty sets
1144 global_release_barriers.erase(set_it);
1145 }
1146 }
1147 }
1148}
1149
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001150void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001151 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1152 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001153}
1154
John Zulauf6b4aae82018-05-09 13:03:36 -06001155// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001156void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001157
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001158void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001159 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001160 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001161 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001162
Chris Forbes4de4b132017-08-21 11:27:08 -07001163 // For ownership transfers, the barrier is specified twice; as a release
1164 // operation on the yielding queue family, and as an acquire operation
1165 // on the acquiring queue family. This barrier may also include a layout
1166 // transition, which occurs 'between' the two operations. For validation
1167 // purposes it doesn't seem important which side performs the layout
1168 // transition, but it must not be performed twice. We'll arbitrarily
1169 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001170 //
1171 // However, we still need to record initial layout for the "initial layout" validation
1172 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001173
Petr Krausad0096a2019-08-09 18:35:04 +02001174 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001175 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001176 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001177 }
1178}
1179
unknown86bcb3a2019-07-11 13:05:36 -06001180void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001181 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001182 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1183 const auto &image_create_info = image_state->createInfo;
1184
1185 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1186 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1187 // for all (potential) layer sub_resources.
1188 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1189 normalized_isr.baseArrayLayer = 0;
1190 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1191 }
1192
Michael Spang8af7c102020-05-03 20:50:09 -04001193 VkImageLayout initial_layout = mem_barrier.oldLayout;
1194
1195 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001196 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001197 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1198 }
1199
John Zulauf2be3fe02019-12-30 09:48:02 -07001200 if (is_release_op) {
1201 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1202 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001203 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001204 }
unknown86bcb3a2019-07-11 13:05:36 -06001205}
1206
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001207bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1208 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1209 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1210 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001211 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001212 assert(cb_node);
1213 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001214 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001215 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001216
John Zulauff660ad62019-03-23 07:16:05 -06001217 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1218 if (subresource_map) {
1219 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001220 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001221 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1222 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001223 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001224 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1225 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1226 "%s layout %s.",
1227 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1228 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1229 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001230 }
John Zulauf5e617452019-11-19 14:44:16 -07001231 }
John Zulauff660ad62019-03-23 07:16:05 -06001232 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001233 }
John Zulauff660ad62019-03-23 07:16:05 -06001234
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001235 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1236 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1237 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001238 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1239 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001240 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1241 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1242 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001243 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001244 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001245 if (image_state->shared_presentable) {
1246 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001247 skip |= LogError(device, layout_invalid_msg_code,
1248 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1249 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001250 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001251 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001252 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001253 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001254 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1255 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1256 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1257 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001258 }
1259 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001260 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001261}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001262bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001263 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1264 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001265 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001266 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1267 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1268}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001269
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001270void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001271 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001272 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001273 if (!renderPass) return;
1274
Tobias Hectorbbb12282018-10-22 15:17:59 +01001275 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001276 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001277 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001278 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001279 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1280 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1281 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1282 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001283 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001284 }
John Zulauf8e308292018-09-21 11:34:37 -06001285 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001286 VkImageLayout stencil_layout = kInvalidLayout;
1287 const auto *attachment_description_stencil_layout =
1288 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1289 if (attachment_description_stencil_layout) {
1290 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1291 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001292 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001293 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001294 }
1295 }
1296}
Dave Houltone19e20d2018-02-02 16:32:41 -07001297
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001298#ifdef VK_USE_PLATFORM_ANDROID_KHR
1299// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1300// This could also move into a seperate core_validation_android.cpp file... ?
1301
1302//
1303// AHB-specific validation within non-AHB APIs
1304//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001305bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001306 bool skip = false;
1307
1308 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1309 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001310 if (0 != ext_fmt_android->externalFormat) {
1311 if (VK_FORMAT_UNDEFINED != create_info->format) {
1312 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001313 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1314 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1315 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001316 }
1317
1318 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001319 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1320 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1321 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001322 }
1323
1324 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001325 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1326 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001327 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1328 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1329 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001330 }
1331
1332 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001333 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1334 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1335 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001336 }
1337 }
1338
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001339 if ((0 != ext_fmt_android->externalFormat) &&
1340 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001341 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001342 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1343 ") which has "
1344 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1345 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001346 }
1347 }
1348
Dave Houltond9611312018-11-19 17:03:36 -07001349 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001350 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001351 skip |=
1352 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1353 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1354 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001355 }
1356 }
1357
1358 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1359 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1360 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001361 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001362 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1363 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1364 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1365 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001366 }
1367
1368 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001369 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1370 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1371 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1372 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1373 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001374 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001375 }
1376
1377 return skip;
1378}
1379
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001380bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001381 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001382 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001383
1384 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001385 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001386 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1387 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001388 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001389 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001390 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001391
Dave Houltond9611312018-11-19 17:03:36 -07001392 // Chain must include a compatible ycbcr conversion
1393 bool conv_found = false;
1394 uint64_t external_format = 0;
1395 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1396 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001397 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001398 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001399 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001400 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001401 }
Dave Houltond9611312018-11-19 17:03:36 -07001402 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001403 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001404 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001405 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1406 "an externalFormat (%" PRIu64
1407 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1408 "with the same external format.",
1409 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001410 }
1411
1412 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001413 if (IsIdentitySwizzle(create_info->components) == false) {
1414 skip |= LogError(
1415 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1416 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1417 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1418 "= %s.",
1419 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1420 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001421 }
1422 }
Dave Houltond9611312018-11-19 17:03:36 -07001423
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001424 return skip;
1425}
1426
John Zulaufa26d3c82019-08-14 16:09:08 -06001427bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001428 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001429
John Zulaufa26d3c82019-08-14 16:09:08 -06001430 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001431 if (image_state != nullptr) {
1432 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1433 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1434 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1435 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1436 "bound to memory.");
1437 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001438 }
1439 return skip;
1440}
1441
1442#else
1443
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001444bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001445 return false;
1446}
1447
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001448bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001449
John Zulaufa26d3c82019-08-14 16:09:08 -06001450bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001451
1452#endif // VK_USE_PLATFORM_ANDROID_KHR
1453
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001454bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1455 bool skip = false;
1456
1457 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1458 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1459 const VkImageTiling image_tiling = pCreateInfo->tiling;
1460 const VkFormat image_format = pCreateInfo->format;
1461
1462 if (image_format == VK_FORMAT_UNDEFINED) {
1463 // VU 01975 states format can't be undefined unless an android externalFormat
1464#ifdef VK_USE_PLATFORM_ANDROID_KHR
1465 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1466 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1467 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1468 if (it != ahb_ext_formats_map.end()) {
1469 tiling_features = it->second;
1470 }
1471 }
1472#endif
1473 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1474 uint64_t drm_format_modifier = 0;
1475 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1476 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1477 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1478 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1479
1480 if (drm_explicit != nullptr) {
1481 drm_format_modifier = drm_explicit->drmFormatModifier;
1482 } else {
1483 // VUID 02261 makes sure its only explict or implict in parameter checking
1484 assert(drm_implicit != nullptr);
1485 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1486 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1487 }
1488 }
1489
1490 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1491 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1492 nullptr};
1493 format_properties_2.pNext = (void *)&drm_properties_list;
1494 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
1495
1496 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1497 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1498 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1499 }
1500 }
1501 } else {
1502 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1503 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1504 : format_properties.optimalTilingFeatures;
1505 }
1506
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001507 // Lack of disjoint format feature support while using the flag
1508 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1509 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1510 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1511 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1512 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1513 string_VkFormat(pCreateInfo->format));
1514 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001515
1516 return skip;
1517}
1518
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001519bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001520 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001521 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001522
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001523 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001524 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001525 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1526 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001527 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1528 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001529 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001530 }
1531
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001532 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1533 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001534 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1535 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1536 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001537 }
1538
1539 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001540 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1541 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1542 "height (%d) and arrayLayers (%d) must be >= 6.",
1543 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001544 }
Dave Houlton130c0212018-01-29 13:39:56 -07001545 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001546
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001547 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001548 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1549 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1550 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001551 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1552 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1553 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001554 }
1555
1556 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001557 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1558 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1559 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001560 }
1561
ByumjinConffx991b6062019-08-14 15:17:53 -07001562 if (device_extensions.vk_ext_fragment_density_map) {
1563 uint32_t ceiling_width =
1564 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1565 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1566 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1567 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001568 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1569 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1570 "ceiling of device "
1571 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1572 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1573 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001574 }
1575
1576 uint32_t ceiling_height =
1577 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1578 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1579 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1580 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001581 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1582 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1583 "ceiling of device "
1584 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1585 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1586 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001587 }
1588 }
1589
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001590 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001591 VkResult result = VK_SUCCESS;
1592 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1593 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1594 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1595 &format_limits);
1596 } else {
1597 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1598 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1599 image_format_info.type = pCreateInfo->imageType;
1600 image_format_info.tiling = pCreateInfo->tiling;
1601 image_format_info.usage = pCreateInfo->usage;
1602 image_format_info.flags = pCreateInfo->flags;
1603 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1604 format_limits = image_format_properties.imageFormatProperties;
1605 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001606
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001607 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001608#ifdef VK_USE_PLATFORM_ANDROID_KHR
1609 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1610#endif // VK_USE_PLATFORM_ANDROID_KHR
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001611 skip |= LogError(device, kVUID_Core_Image_FormatNotSupported,
1612 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
1613 "VkGetPhysicalDeviceImageFormatProperties returned back VK_ERROR_FORMAT_NOT_SUPPORTED.",
1614 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001615 } else {
1616 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1617 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001618 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1619 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1620 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001621 }
Dave Houlton130c0212018-01-29 13:39:56 -07001622
Dave Houltona585d132019-01-18 13:05:42 -07001623 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1624 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1625 (uint64_t)pCreateInfo->samples;
1626 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001627
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001628 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001629 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001630 uint64_t ig_mask = imageGranularity - 1;
1631 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001632
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001633 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001634 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1635 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1636 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1637 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001638 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001639
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001640 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001641 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1642 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1643 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001644 }
1645
1646 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001647 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1648 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1649 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001650 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001651 }
1652
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001653 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001654 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1655 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1656 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1657 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001658 skip |= LogError(device, error_vuid,
1659 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1660 "YCbCr Conversion format, arrayLayers must be 1",
1661 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001662 }
1663
1664 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001665 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1666 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1667 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001668 }
1669
1670 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001671 skip |= LogError(
1672 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001673 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1674 string_VkSampleCountFlagBits(pCreateInfo->samples));
1675 }
1676
1677 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001678 skip |= LogError(
1679 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001680 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1681 string_VkImageType(pCreateInfo->imageType));
1682 }
1683 }
1684
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001685 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001686 skip |=
1687 LogError(device, "VUID-VkImageCreateInfo-flags-01924",
1688 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1689 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001690 }
1691
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001692 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001693 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001694 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1695 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001696 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1697 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1698 "format must be block, ETC or ASTC compressed, but is %s",
1699 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001700 }
1701 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001702 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1703 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1704 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001705 }
1706 }
1707 }
1708
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001709 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001710 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1711 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1712 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001713 }
1714
unknown2c877272019-07-11 12:56:50 -06001715 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1716 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1717 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001718 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1719 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1720 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001721 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001722
1723 skip |= ValidateImageFormatFeatures(pCreateInfo);
1724
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001725 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001726}
1727
John Zulauf7eeb6f72019-06-17 11:56:36 -06001728void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1729 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1730 if (VK_SUCCESS != result) return;
1731
1732 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001733 auto image_state = Get<IMAGE_STATE>(*pImage);
1734 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001735}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001736
Jeff Bolz5c801d12019-10-09 10:38:45 -05001737bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001738 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001739 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001740 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001741 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001742 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001743 }
1744 return skip;
1745}
1746
John Zulauf7eeb6f72019-06-17 11:56:36 -06001747void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1748 // Clean up validation specific data
1749 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001750
locke-lunargcba7d5f2019-12-30 16:59:11 -07001751 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001752
1753 // Clean up generic image state
1754 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001755}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001756
sfricke-samsungcd924d92020-05-20 23:51:17 -07001757bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
1758 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001759 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07001760 const VkImage image = image_state->image;
1761 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001762
1763 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001764 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
1765 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001766 }
1767
sfricke-samsungcd924d92020-05-20 23:51:17 -07001768 if (FormatIsDepthOrStencil(format)) {
1769 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1770 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
1771 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
1772 } else if (FormatIsCompressed(format)) {
1773 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1774 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
1775 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001776 }
1777
1778 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001779 skip |=
1780 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
1781 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
1782 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001783 }
1784 return skip;
1785}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001786
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001787uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1788 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1789 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001790 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001791 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001792 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001793 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001794}
1795
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001796uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1797 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1798 uint32_t array_layer_count = range->layerCount;
1799 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1800 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001801 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001802 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001803}
1804
John Zulauf07288512019-07-05 11:09:50 -06001805bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1806 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1807 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001808 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001809 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1810 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001811 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1812 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1813 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001814 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001815
1816 } else {
1817 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1818 if (!device_extensions.vk_khr_shared_presentable_image) {
1819 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001820 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1821 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1822 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001823 }
1824 } else {
1825 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1826 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001827 skip |= LogError(
1828 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001829 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1830 func_name, string_VkImageLayout(dest_image_layout));
1831 }
1832 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001833 }
1834
John Zulauff660ad62019-03-23 07:16:05 -06001835 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001836 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001837 if (subresource_map) {
1838 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001839 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001840 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001841 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1842 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001843 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1844 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1845 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1846 } else {
1847 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001848 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001849 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1850 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1851 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1852 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001853 }
John Zulauf5e617452019-11-19 14:44:16 -07001854 }
John Zulauff660ad62019-03-23 07:16:05 -06001855 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001856 }
1857
1858 return skip;
1859}
1860
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001861bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1862 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001863 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001864 bool skip = false;
1865 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001866 const auto *cb_node = GetCBState(commandBuffer);
1867 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001868 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001869 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001870 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001871 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001872 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001873 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001874 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1875 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001876 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001877 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001878 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001879 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001880 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07001881 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001882 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001883 }
sfricke-samsunge775d492020-02-28 09:02:25 -08001884 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
1885 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
1886 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
1887 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
1888 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
1889 string_VkFormat(image_state->createInfo.format));
1890 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001891 }
1892 return skip;
1893}
1894
John Zulaufeabb4462019-07-05 14:13:03 -06001895void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1896 const VkClearColorValue *pColor, uint32_t rangeCount,
1897 const VkImageSubresourceRange *pRanges) {
1898 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1899
1900 auto cb_node = GetCBState(commandBuffer);
1901 auto image_state = GetImageState(image);
1902 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001903 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001904 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001905 }
1906 }
1907}
1908
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001909bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1910 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001911 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001912 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001913
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001914 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001915 const auto *cb_node = GetCBState(commandBuffer);
1916 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001917 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001918 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001919 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001920 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001921 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001922 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001923 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001924 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001925 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001926 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001927 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001928
1929 bool any_include_aspect_depth_bit = false;
1930 bool any_include_aspect_stencil_bit = false;
1931
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001932 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001933 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001934 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001935 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001936 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001937 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1938 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001939 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
1940 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
1941 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
1942 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001943 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001944 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1945 any_include_aspect_depth_bit = true;
1946 }
1947 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1948 any_include_aspect_stencil_bit = true;
1949 }
1950 }
1951 if (any_include_aspect_stencil_bit) {
1952 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1953 if (image_stencil_struct != nullptr) {
1954 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1955 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001956 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1957 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1958 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1959 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001960 }
1961 } else {
1962 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001963 skip |= LogError(
1964 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05001965 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1966 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1967 "in VkImageCreateInfo::usage used to create image");
1968 }
1969 }
1970 }
1971 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001972 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1973 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1974 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001975 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001976 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001977 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
1978 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
1979 report_data->FormatHandle(image).c_str(), string_VkFormat(image_state->createInfo.format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001980 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001981 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001982 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
1983 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
1984 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
1985 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001986 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001987 }
1988 return skip;
1989}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001990
John Zulaufeabb4462019-07-05 14:13:03 -06001991void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1992 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1993 const VkImageSubresourceRange *pRanges) {
1994 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1995 auto cb_node = GetCBState(commandBuffer);
1996 auto image_state = GetImageState(image);
1997 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001998 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001999 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002000 }
2001 }
2002}
2003
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002004// Returns true if [x, xoffset] and [y, yoffset] overlap
2005static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2006 bool result = false;
2007 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2008 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2009
2010 if (intersection_max > intersection_min) {
2011 result = true;
2012 }
2013 return result;
2014}
2015
Dave Houltonc991cc92018-03-06 11:08:51 -07002016// Returns true if source area of first copy region intersects dest area of second region
2017// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2018static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002019 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002020
Dave Houltonc991cc92018-03-06 11:08:51 -07002021 // Separate planes within a multiplane image cannot intersect
2022 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002023 return result;
2024 }
2025
Dave Houltonc991cc92018-03-06 11:08:51 -07002026 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2027 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2028 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002029 result = true;
2030 switch (type) {
2031 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002032 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002033 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002034 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002035 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002036 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002037 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002038 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002039 break;
2040 default:
2041 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2042 assert(false);
2043 }
2044 }
2045 return result;
2046}
2047
Dave Houltonfc1a4052017-04-27 14:32:45 -06002048// Returns non-zero if offset and extent exceed image extents
2049static const uint32_t x_bit = 1;
2050static const uint32_t y_bit = 2;
2051static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002052static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002053 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002054 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002055 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2056 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002057 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002058 }
2059 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2060 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002061 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002062 }
2063 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2064 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002065 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002066 }
2067 return result;
2068}
2069
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002070// Test if two VkExtent3D structs are equivalent
2071static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2072 bool result = true;
2073 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2074 (extent->depth != other_extent->depth)) {
2075 result = false;
2076 }
2077 return result;
2078}
2079
Dave Houltonee281a52017-12-08 13:51:02 -07002080// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
2081// Destination image texel extents must be adjusted by block size for the dest validation checks
2082VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
2083 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06002084 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2085 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002086 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002087 adjusted_extent.width /= block_size.width;
2088 adjusted_extent.height /= block_size.height;
2089 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06002090 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2091 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002092 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002093 adjusted_extent.width *= block_size.width;
2094 adjusted_extent.height *= block_size.height;
2095 adjusted_extent.depth *= block_size.depth;
2096 }
2097 return adjusted_extent;
2098}
2099
Dave Houlton6f9059e2017-05-02 17:15:13 -06002100// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002101static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2102 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002103
2104 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002105 if (mip >= img->createInfo.mipLevels) {
2106 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002107 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002108
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002109 // 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 -06002110 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002111
Dave Houltone48cd112019-01-03 17:01:18 -07002112 // If multi-plane, adjust per-plane extent
2113 if (FormatIsMultiplane(img->createInfo.format)) {
2114 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2115 extent.width /= divisors.width;
2116 extent.height /= divisors.height;
2117 }
2118
Jeff Bolzef40fec2018-09-01 22:04:34 -05002119 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2120 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002121 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002122 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2123 } else {
2124 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2125 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2126 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2127 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002128
Dave Houlton6f9059e2017-05-02 17:15:13 -06002129 // Image arrays have an effective z extent that isn't diminished by mip level
2130 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002131 extent.depth = img->createInfo.arrayLayers;
2132 }
2133
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002134 return extent;
2135}
2136
2137// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002138static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002139 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2140}
2141
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002142// Test if the extent argument has any dimensions set to 0.
2143static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2144 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2145}
2146
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002147// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002148VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002149 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2150 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002151 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002152 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002153 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002154 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002155 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002156 granularity.width *= block_size.width;
2157 granularity.height *= block_size.height;
2158 }
2159 }
2160 return granularity;
2161}
2162
2163// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2164static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2165 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002166 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2167 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002168 valid = false;
2169 }
2170 return valid;
2171}
2172
2173// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002174bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002175 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002176 bool skip = false;
2177 VkExtent3D offset_extent = {};
2178 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2179 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2180 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002181 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002182 // 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 -07002183 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002184 skip |= LogError(cb_node->commandBuffer, vuid,
2185 "%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 "
2186 "image transfer granularity is (w=0, h=0, d=0).",
2187 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002188 }
2189 } else {
2190 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2191 // integer multiples of the image transfer granularity.
2192 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002193 skip |= LogError(cb_node->commandBuffer, vuid,
2194 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2195 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2196 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2197 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002198 }
2199 }
2200 return skip;
2201}
2202
2203// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002204bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002205 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002206 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002207 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002208 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002209 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2210 // subresource extent.
2211 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002212 skip |= LogError(cb_node->commandBuffer, vuid,
2213 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2214 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2215 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2216 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002217 }
2218 } else {
2219 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2220 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2221 // subresource extent dimensions.
2222 VkExtent3D offset_extent_sum = {};
2223 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2224 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2225 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002226 bool x_ok = true;
2227 bool y_ok = true;
2228 bool z_ok = true;
2229 switch (image_type) {
2230 case VK_IMAGE_TYPE_3D:
2231 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2232 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002233 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002234 case VK_IMAGE_TYPE_2D:
2235 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2236 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002237 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002238 case VK_IMAGE_TYPE_1D:
2239 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2240 (subresource_extent->width == offset_extent_sum.width));
2241 break;
2242 default:
2243 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2244 assert(false);
2245 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002246 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002247 skip |=
2248 LogError(cb_node->commandBuffer, vuid,
2249 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2250 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2251 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2252 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2253 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2254 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002255 }
2256 }
2257 return skip;
2258}
2259
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002260bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002261 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002262 bool skip = false;
2263 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002264 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2265 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002266 }
2267 return skip;
2268}
2269
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002270bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002271 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002272 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002273 bool skip = false;
2274 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2275 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002276 skip |= LogError(cb_node->commandBuffer, vuid,
2277 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2278 "%u, but provided %s has %u array layers.",
2279 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2280 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002281 }
2282 return skip;
2283}
2284
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002285// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002286bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002287 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002288 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002289 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002290 VkExtent3D granularity = GetScaledItg(cb_node, img);
2291 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002292 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002293 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002294 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002295 return skip;
2296}
2297
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002298// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002299bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002300 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002301 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002302 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002303 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002304 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2305 skip |=
2306 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002307 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002308 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002309 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2310 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002311
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002312 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002313 granularity = GetScaledItg(cb_node, dst_img);
2314 skip |=
2315 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002316 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002317 const VkExtent3D dest_effective_extent =
2318 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002319 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002320 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002321 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002322 return skip;
2323}
2324
Dave Houlton6f9059e2017-05-02 17:15:13 -06002325// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002326bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002327 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002328 bool skip = false;
2329
2330 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002331 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002332
2333 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002334 const VkExtent3D src_copy_extent = region.extent;
2335 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002336 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2337
Dave Houlton6f9059e2017-05-02 17:15:13 -06002338 bool slice_override = false;
2339 uint32_t depth_slices = 0;
2340
2341 // Special case for copying between a 1D/2D array and a 3D image
2342 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2343 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002344 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002345 slice_override = (depth_slices != 1);
2346 } 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 -07002347 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002348 slice_override = (depth_slices != 1);
2349 }
2350
2351 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002352 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002353 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002354 skip |=
2355 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2356 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2357 "be 0 and 1, respectively.",
2358 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002359 }
2360 }
2361
Dave Houlton533be9f2018-03-26 17:08:30 -06002362 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 -07002363 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2364 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2365 "these must be 0 and 1, respectively.",
2366 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002367 }
2368
Dave Houlton533be9f2018-03-26 17:08:30 -06002369 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002370 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2371 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2372 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002373 }
2374
Dave Houltonc991cc92018-03-06 11:08:51 -07002375 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002376 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002377 if (FormatIsCompressed(src_state->createInfo.format) ||
2378 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002379 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002380 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002381 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2382 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2383 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002384 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002385 skip |= LogError(src_state->image, vuid,
2386 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2387 "texel width & height (%d, %d).",
2388 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002389 }
2390
Dave Houlton94a00372017-12-14 15:08:47 -07002391 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002392 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2393 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002394 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002395 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002396 LogError(src_state->image, vuid,
2397 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2398 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2399 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002400 }
2401
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002402 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002403 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2404 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002405 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002406 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002407 LogError(src_state->image, vuid,
2408 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2409 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2410 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002411 }
2412
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002413 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002414 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2415 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002416 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002417 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002418 LogError(src_state->image, vuid,
2419 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2420 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2421 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002422 }
2423 } // Compressed
2424
2425 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002426 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002427 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002428 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2429 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2430 "these must be 0 and 1, respectively.",
2431 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002432 }
2433 }
2434
Dave Houlton533be9f2018-03-26 17:08:30 -06002435 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 -07002436 skip |=
2437 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2438 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2439 "and 1, respectively.",
2440 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002441 }
2442
Dave Houlton533be9f2018-03-26 17:08:30 -06002443 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002444 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2445 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2446 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002447 }
2448
sfricke-samsung30b094c2020-05-30 11:42:11 -07002449 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002450 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002451 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2452 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
2453 skip |=
2454 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2455 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2456 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2457 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2458 }
2459 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002460 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002461 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002462 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002463 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2464 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2465 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2466 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002467 }
2468 }
2469 } else { // Pre maint 1
2470 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002471 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
2472 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00139",
2473 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2474 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2475 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2476 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2477 }
Dave Houltonee281a52017-12-08 13:51:02 -07002478 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002479 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00139",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002480 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2481 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2482 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2483 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002484 }
2485 }
2486 }
2487
Dave Houltonc991cc92018-03-06 11:08:51 -07002488 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2489 if (FormatIsCompressed(dst_state->createInfo.format) ||
2490 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002491 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002492
2493 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002494 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2495 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2496 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002497 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002498 skip |= LogError(dst_state->image, vuid,
2499 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2500 "texel width & height (%d, %d).",
2501 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002502 }
2503
Dave Houlton94a00372017-12-14 15:08:47 -07002504 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002505 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2506 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002507 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002508 skip |= LogError(
2509 dst_state->image, vuid,
2510 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2511 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2512 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002513 }
2514
Dave Houltonee281a52017-12-08 13:51:02 -07002515 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2516 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2517 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002518 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002519 skip |= LogError(dst_state->image, vuid,
2520 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2521 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2522 "height (%d).",
2523 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002524 }
2525
Dave Houltonee281a52017-12-08 13:51:02 -07002526 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2527 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2528 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002529 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002530 skip |= LogError(
2531 dst_state->image, vuid,
2532 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2533 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2534 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002535 }
2536 } // Compressed
2537 }
2538 return skip;
2539}
2540
Dave Houltonc991cc92018-03-06 11:08:51 -07002541// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002542bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002543 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002544 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002545
2546 // Neither image is multiplane
2547 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2548 // If neither image is multi-plane the aspectMask member of src and dst must match
2549 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2550 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002551 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002552 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002553 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002554 }
2555 } else {
2556 // Source image multiplane checks
2557 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2558 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2559 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2560 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002561 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002562 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002563 }
2564 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2565 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2566 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002567 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002568 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002569 }
2570 // Single-plane to multi-plane
2571 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2572 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2573 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002574 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002575 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002576 }
2577
2578 // Dest image multiplane checks
2579 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2580 aspect = region.dstSubresource.aspectMask;
2581 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2582 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002583 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002584 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002585 }
2586 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2587 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2588 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002589 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002590 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002591 }
2592 // Multi-plane to single-plane
2593 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2594 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2595 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002596 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002597 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002598 }
2599 }
2600
2601 return skip;
2602}
2603
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002604bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2605 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002606 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002607 const auto *cb_node = GetCBState(commandBuffer);
2608 const auto *src_image_state = GetImageState(srcImage);
2609 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002610 const VkFormat src_format = src_image_state->createInfo.format;
2611 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002612 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002613
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002614 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002615
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002616 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2617
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002618 for (uint32_t i = 0; i < regionCount; i++) {
2619 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002620
2621 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2622 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002623 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002624
Dave Houlton6f9059e2017-05-02 17:15:13 -06002625 bool slice_override = false;
2626 uint32_t depth_slices = 0;
2627
2628 // Special case for copying between a 1D/2D array and a 3D image
2629 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2630 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2631 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002632 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002633 slice_override = (depth_slices != 1);
2634 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2635 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002636 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002637 slice_override = (depth_slices != 1);
2638 }
2639
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002640 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2641 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2642 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002643 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002644 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002645 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002646 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002647 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2648 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002649 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002650 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2651 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002652
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002653 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002654 // No chance of mismatch if we're overriding depth slice count
2655 if (!slice_override) {
2656 // The number of depth slices in srcSubresource and dstSubresource must match
2657 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2658 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002659 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2660 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002661 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002662 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2663 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002664 if (src_slices != dst_slices) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002665 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140",
2666 "vkCmdCopyImage(): number of depth slices in source and destination subresources for "
2667 "pRegions[%u] do not match.",
2668 i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002669 }
2670 }
2671 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002672 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002673 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002674 skip |= LogError(
2675 command_buffer, "VUID-VkImageCopy-layerCount-00138",
2676 "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[%u] do not match", i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002677 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002678 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002679
Dave Houltonc991cc92018-03-06 11:08:51 -07002680 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002681 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002682 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002683 }
2684
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002685 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002686 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2687 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002688 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002689 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002690 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002691 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002692
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002693 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002694 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002695 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002696 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002697 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002698 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002699 }
2700
2701 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002702 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002703 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002704 ss << "vkCmdCopyImage(): pRegion[" << i
2705 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002706 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002707 }
2708
Dave Houltonfc1a4052017-04-27 14:32:45 -06002709 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002710 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2711 if (slice_override) src_copy_extent.depth = depth_slices;
2712 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002713 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002714 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002715 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2716 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2717 "width [%1d].",
2718 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002719 }
2720
2721 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002722 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002723 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2724 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2725 "height [%1d].",
2726 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002727 }
2728 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002729 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002730 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2731 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2732 "depth [%1d].",
2733 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002734 }
2735
Dave Houltonee281a52017-12-08 13:51:02 -07002736 // Adjust dest extent if necessary
2737 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2738 if (slice_override) dst_copy_extent.depth = depth_slices;
2739
2740 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002741 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002742 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2743 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2744 "width [%1d].",
2745 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002746 }
2747 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002748 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2749 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2750 "height [%1d].",
2751 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002752 }
2753 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002754 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2755 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2756 "depth [%1d].",
2757 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002758 }
2759
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002760 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2761 // must not overlap in memory
2762 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002763 for (uint32_t j = 0; j < regionCount; j++) {
2764 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002765 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002766 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002767 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002768 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002769 }
2770 }
2771 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002772
2773 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2774 if (device_extensions.vk_khr_maintenance1) {
2775 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2776 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2777 (src_copy_extent.depth != 1)) {
2778 skip |= LogError(
2779 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2780 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2781 src_copy_extent.depth);
2782 }
2783 } else {
2784 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2785 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2786 (src_copy_extent.depth != 1)) {
2787 skip |= LogError(
2788 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2789 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2790 src_copy_extent.depth);
2791 }
2792 }
2793
2794 // Check if 2D with 3D and depth not equal to 2D layerCount
2795 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2796 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2797 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2798 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2799 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2800 "srcSubresource.layerCount (%u)",
2801 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2802 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2803 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2804 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2805 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2806 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2807 "dstSubresource.layerCount (%u)",
2808 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2809 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002810
2811 // Check for multi-plane format compatiblity
2812 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
2813 size_t src_format_size = 0;
2814 size_t dst_format_size = 0;
2815 if (FormatIsMultiplane(src_format)) {
2816 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
2817 src_format_size = FormatElementSize(planeFormat);
2818 } else {
2819 src_format_size = FormatElementSize(src_format);
2820 }
2821 if (FormatIsMultiplane(dst_format)) {
2822 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
2823 dst_format_size = FormatElementSize(planeFormat);
2824 } else {
2825 dst_format_size = FormatElementSize(dst_format);
2826 }
2827 // If size is still zero, then format is invalid and will be caught in another VU
2828 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
2829 skip |=
2830 LogError(command_buffer, "VUID-vkCmdCopyImage-None-01549",
2831 "vkCmdCopyImage(): pRegions[%u] called with non-compatible image formats. "
2832 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
2833 i, string_VkFormat(src_format), string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(),
2834 string_VkFormat(dst_format), string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
2835 }
2836 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002837 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002838
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002839 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
2840 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
2841 // because because both texels are 4 bytes in size.
2842 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
2843 const char *compatible_vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2844 : "VUID-vkCmdCopyImage-srcImage-00135";
2845 // Depth/stencil formats must match exactly.
2846 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2847 if (src_format != dst_format) {
2848 skip |= LogError(command_buffer, compatible_vuid,
2849 "vkCmdCopyImage(): Depth/stencil formats must match exactly for src (%s) and dst (%s).",
2850 string_VkFormat(src_format), string_VkFormat(dst_format));
2851 }
2852 } else {
2853 if (!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) {
2854 skip |= LogError(command_buffer, compatible_vuid,
2855 "vkCmdCopyImage(): Unmatched image format sizes. "
2856 "The src format %s has size of %zu and dst format %s has size of %zu.",
2857 string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
2858 FormatElementSize(dst_format));
2859 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002860 }
2861 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002862
Dave Houlton33c22b72017-02-28 13:16:02 -07002863 // Source and dest image sample counts must match
2864 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2865 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002866 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002867 }
2868
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002869 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2870 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002871 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002872 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2873 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2874 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2875 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02002876
2877 // Validation for VK_EXT_fragment_density_map
2878 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2879 skip |= LogError(
2880 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2881 "vkCmdCopyImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2882 }
2883 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2884 skip |= LogError(
2885 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2886 "vkCmdCopyImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2887 }
2888
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002889 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002890 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002891 "VUID-vkCmdCopyImage-srcImage-01995");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002892 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002893 "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002894 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002895 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002896 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002897 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2898 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002899 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002900 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2901 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2902 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2903 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2904 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2905 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002906 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002907 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002908 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2909 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002910 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002911 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2912 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002913 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2914 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002915 }
2916
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002917 return skip;
2918}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002919
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002920void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2921 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2922 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002923 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2924 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002925 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002926 auto src_image_state = GetImageState(srcImage);
2927 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002928
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002929 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002930 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002931 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2932 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002933 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002934}
2935
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002936// Returns true if sub_rect is entirely contained within rect
2937static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2938 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2939 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2940 return false;
2941 return true;
2942}
2943
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002944bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002945 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2946 const VkRect2D &render_area, uint32_t rect_count,
2947 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002948 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002949 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2950 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06002951 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07002952 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002953
2954 for (uint32_t j = 0; j < rect_count; j++) {
2955 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002956 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2957 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2958 "the current render pass instance.",
2959 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002960 }
2961
2962 if (image_view_state) {
2963 // The layers specified by a given element of pRects must be contained within every attachment that
2964 // pAttachments refers to
2965 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2966 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2967 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002968 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2969 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2970 "of pAttachment[%d].",
2971 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002972 }
2973 }
2974 }
2975 return skip;
2976}
2977
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002978bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2979 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002980 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002981 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002982 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002983 if (!cb_node) return skip;
2984
2985 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2986 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2987 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002988 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002989
2990 // Validate that attachment is in reference list of active subpass
2991 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002992 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002993 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002994 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002995 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002996 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002997
John Zulauf3a548ef2019-02-01 16:14:07 -07002998 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2999 auto clear_desc = &pAttachments[attachment_index];
3000 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003001
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003002 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003003 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003004 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003005 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003006 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003007 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3008 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3009 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3010 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003011 skip |= LogError(
3012 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3013 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3014 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3015 attachment_index, clear_desc->colorAttachment,
3016 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3017 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003018
John Zulauff2582972019-02-09 14:53:30 -07003019 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3020 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003021 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003022 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3023 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3024 " subpass %u. colorAttachmentCount=%u",
3025 attachment_index, clear_desc->colorAttachment,
3026 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3027 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003028 }
John Zulauff2582972019-02-09 14:53:30 -07003029 fb_attachment = color_attachment;
3030
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003031 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3032 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3033 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003034 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003035 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003036 }
3037 } else { // Must be depth and/or stencil
3038 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
3039 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003040 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003041 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003042 }
3043 if (!subpass_desc->pDepthStencilAttachment ||
3044 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003045 skip |= LogPerformanceWarning(
3046 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003047 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003048 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003049 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003050 }
3051 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003052 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003053 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3054 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003055 }
3056 }
3057 }
3058 return skip;
3059}
3060
3061void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3062 const VkClearAttachment *pAttachments, uint32_t rectCount,
3063 const VkClearRect *pRects) {
3064 auto *cb_node = GetCBState(commandBuffer);
3065 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3066 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3067 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3068 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3069 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3070 const auto clear_desc = &pAttachments[attachment_index];
3071 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3072 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3073 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3074 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3075 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3076 subpass_desc->pDepthStencilAttachment) {
3077 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3078 }
3079 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003080 if (!clear_rect_copy) {
3081 // We need a copy of the clear rectangles that will persist until the last lambda executes
3082 // but we want to create it as lazily as possible
3083 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003084 }
John Zulauf441558b2019-08-12 11:47:39 -06003085 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3086 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003087 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003088 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003089 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003090 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003091 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3092 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003093 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3094 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003095 return skip;
3096 };
3097 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003098 }
3099 }
3100 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003101}
3102
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003103bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3104 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003105 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003106 const auto *cb_node = GetCBState(commandBuffer);
3107 const auto *src_image_state = GetImageState(srcImage);
3108 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003109
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003110 bool skip = false;
3111 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003112 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3113 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003114 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003115 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003116 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3117 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003118 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003119 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003120
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003121 // Validation for VK_EXT_fragment_density_map
3122 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3123 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3124 "vkCmdResolveImage(): srcImage must not have been created with flags containing "
3125 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3126 }
3127 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3128 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3129 "vkCmdResolveImage(): dstImage must not have been created with flags containing "
3130 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3131 }
3132
Cort Stratton7df30962018-05-17 19:45:57 -07003133 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003134 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003135 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003136 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3137 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3138 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003139 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003140 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3141 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003142 // For each region, the number of layers in the image subresource should not be zero
3143 // For each region, src and dest image aspect must be color only
3144 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003145 skip |=
3146 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3147 skip |=
3148 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003149 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003150 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3151 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003152 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003153 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3154 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003155 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3156 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3157 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3158 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3159 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003160 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3161 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003162 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003163 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3164 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003165
3166 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003167 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003168 skip |= LogError(
3169 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003170 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003171 }
Cort Stratton7df30962018-05-17 19:45:57 -07003172 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003173 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3174 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3175 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003176 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003177 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003178 }
3179 }
3180
3181 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003182 skip |=
3183 LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-01386",
3184 "vkCmdResolveImage(): srcImage format (%s) and dstImage format (%s) are not the same.",
3185 string_VkFormat(src_image_state->createInfo.format), string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003186 }
3187 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003188 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
3189 "vkCmdResolveImage(): srcImage type (%s) and dstImage type (%s) are not the same.",
3190 string_VkImageType(src_image_state->createInfo.imageType),
3191 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003192 }
3193 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003194 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257",
3195 "vkCmdResolveImage(): srcImage sample count is VK_SAMPLE_COUNT_1_BIT.");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003196 }
3197 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003198 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259",
3199 "vkCmdResolveImage(): dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3200 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003201 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003202 } else {
3203 assert(0);
3204 }
3205 return skip;
3206}
3207
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003208bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3209 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003210 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003211 const auto *cb_node = GetCBState(commandBuffer);
3212 const auto *src_image_state = GetImageState(srcImage);
3213 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003214
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003215 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003216 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003217 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003218 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003219 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003220 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003221 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003222 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003223 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003224 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3225 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003226 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003227 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3228 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003229 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003230 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3231 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003232 skip |=
3233 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003234 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3235 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003236 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003237 "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003238 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003239 "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003240
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003241 // Validation for VK_EXT_fragment_density_map
3242 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3243 skip |= LogError(
3244 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3245 "vkCmdBlitImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3246 }
3247 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3248 skip |= LogError(
3249 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3250 "vkCmdBlitImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3251 }
3252
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003253 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003254
Dave Houlton33c2d252017-06-09 17:08:32 -06003255 VkFormat src_format = src_image_state->createInfo.format;
3256 VkFormat dst_format = dst_image_state->createInfo.format;
3257 VkImageType src_type = src_image_state->createInfo.imageType;
3258 VkImageType dst_type = dst_image_state->createInfo.imageType;
3259
Cort Stratton186b1a22018-05-01 20:18:06 -04003260 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003261 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003262 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003263 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003264 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003265 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003266 }
3267
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003268 if (FormatRequiresYcbcrConversion(src_format)) {
3269 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3270 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3271 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3272 string_VkFormat(src_format));
3273 }
3274
3275 if (FormatRequiresYcbcrConversion(dst_format)) {
3276 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3277 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3278 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3279 string_VkFormat(dst_format));
3280 }
3281
Dave Houlton33c2d252017-06-09 17:08:32 -06003282 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003283 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3284 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003285 }
3286
Dave Houlton33c2d252017-06-09 17:08:32 -06003287 // Validate consistency for unsigned formats
3288 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3289 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003290 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003291 << "the other one must also have unsigned integer format. "
3292 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003293 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003294 }
3295
3296 // Validate consistency for signed formats
3297 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3298 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003299 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003300 << "the other one must also have signed integer format. "
3301 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003302 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003303 }
3304
3305 // Validate filter for Depth/Stencil formats
3306 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3307 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003308 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003309 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003310 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003311 }
3312
3313 // Validate aspect bits and formats for depth/stencil images
3314 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3315 if (src_format != dst_format) {
3316 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003317 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003318 << "stencil, the other one must have exactly the same format. "
3319 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3320 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003321 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003322 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003323 } // Depth or Stencil
3324
3325 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003326 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003327 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003328 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3329 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3330 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003331 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003332 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3333 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003334 for (uint32_t i = 0; i < regionCount; i++) {
3335 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003336 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003337 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003338 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3339 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003340 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003341 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3342 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003343 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3344 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3345 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003346 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003347 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003348 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003349 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003350 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3351 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003352 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003353 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3354 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003355 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003356 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3357 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003358 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003359 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003360 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003361 }
Dave Houlton48989f32017-05-26 15:01:46 -06003362 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3363 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003364 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003365 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003366 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003367 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003368
3369 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003370 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003371 skip |= LogError(
3372 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003373 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003374 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003375
Dave Houlton48989f32017-05-26 15:01:46 -06003376 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003377 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3378 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003379 }
Dave Houlton48989f32017-05-26 15:01:46 -06003380
Dave Houlton33c2d252017-06-09 17:08:32 -06003381 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003382 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3383 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3384 "image format %s.",
3385 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003386 }
3387
3388 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003389 skip |= LogError(
3390 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003391 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3392 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003393 }
3394
Dave Houlton48989f32017-05-26 15:01:46 -06003395 // Validate source image offsets
3396 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003397 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003398 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003399 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003400 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3401 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3402 "of (%1d, %1d). These must be (0, 1).",
3403 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003404 }
3405 }
3406
Dave Houlton33c2d252017-06-09 17:08:32 -06003407 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003408 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003409 skip |=
3410 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3411 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3412 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3413 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003414 }
3415 }
3416
Dave Houlton33c2d252017-06-09 17:08:32 -06003417 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003418 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3419 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003420 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003421 skip |= LogError(
3422 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003423 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3424 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003425 }
3426 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3427 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003428 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003429 skip |= LogError(
3430 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003431 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003432 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003433 }
3434 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3435 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003436 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003437 skip |= LogError(
3438 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003439 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3440 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003441 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003442 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003443 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3444 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003445 }
Dave Houlton48989f32017-05-26 15:01:46 -06003446
3447 // Validate dest image offsets
3448 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003449 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003450 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003451 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003452 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3453 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3454 "(%1d, %1d). These must be (0, 1).",
3455 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003456 }
3457 }
3458
Dave Houlton33c2d252017-06-09 17:08:32 -06003459 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003460 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003461 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3462 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3463 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3464 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003465 }
3466 }
3467
Dave Houlton33c2d252017-06-09 17:08:32 -06003468 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003469 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3470 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003471 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003472 skip |= LogError(
3473 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003474 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3475 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003476 }
3477 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3478 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003479 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003480 skip |= LogError(
3481 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003482 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003483 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003484 }
3485 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3486 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003487 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003488 skip |= LogError(
3489 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003490 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3491 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003492 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003493 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003494 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3495 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003496 }
3497
Dave Houlton33c2d252017-06-09 17:08:32 -06003498 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3499 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3500 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003501 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003502 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3503 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3504 "layerCount other than 1.",
3505 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003506 }
3507 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003508 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003509 } else {
3510 assert(0);
3511 }
3512 return skip;
3513}
3514
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003515void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3516 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3517 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003518 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3519 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003520 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003521 auto src_image_state = GetImageState(srcImage);
3522 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003523
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003524 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003525 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003526 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3527 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003528 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003529}
3530
John Zulauf2076e812020-01-08 14:55:54 -07003531GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3532 assert(map);
3533 // This approach allows for a single hash lookup or/create new
3534 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3535 if (inserted.second) {
3536 assert(nullptr == inserted.first->second.get());
3537 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.range_encoder.SubresourceCount());
3538 inserted.first->second.reset(layout_map);
3539 return layout_map;
3540 } else {
3541 assert(nullptr != inserted.first->second.get());
3542 return inserted.first->second.get();
3543 }
3544 return nullptr;
3545}
3546
3547const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3548 auto it = map.find(image);
3549 if (it != map.end()) {
3550 return it->second.get();
3551 }
3552 return nullptr;
3553}
3554
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003555// 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 -07003556bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3557 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06003558 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003559 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003560 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003561 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003562 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003563 for (const auto &layout_map_entry : pCB->image_layout_map) {
3564 const auto image = layout_map_entry.first;
3565 const auto *image_state = GetImageState(image);
3566 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003567 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003568 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003569 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003570 if (initial_layout_map.empty()) continue;
3571
3572 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3573 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3574 if (global_map == nullptr) {
3575 global_map = &empty_map;
3576 }
3577
3578 // Note: don't know if it would matter
3579 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3580
3581 auto pos = initial_layout_map.begin();
3582 const auto end = initial_layout_map.end();
3583 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3584 pos->first.begin);
3585 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003586 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003587 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003588 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 -07003589 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003590 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003591 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003592 image_layout = current_layout->pos_B->lower_bound->second;
3593 }
3594 const auto intersected_range = pos->first & current_layout->range;
3595 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3596 // TODO: Set memory invalid which is in mem_tracker currently
3597 } else if (image_layout != initial_layout) {
3598 // Need to look up the inital layout *state* to get a bit more information
3599 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3600 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3601 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3602 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07003603 // We can report all the errors for the intersected range directly
3604 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
3605 const auto subresource = image_state->range_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003606 skip |= LogError(
3607 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003608 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003609 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07003610 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003611 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06003612 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003613 }
3614 }
John Zulauf2076e812020-01-08 14:55:54 -07003615 if (pos->first.includes(intersected_range.end)) {
3616 current_layout.seek(intersected_range.end);
3617 } else {
3618 ++pos;
3619 if (pos != end) {
3620 current_layout.seek(pos->first.begin);
3621 }
3622 }
John Zulauff660ad62019-03-23 07:16:05 -06003623 }
3624
locke-lunargf155ccf2020-02-18 11:34:15 -07003625 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003626 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003627 }
John Zulauff660ad62019-03-23 07:16:05 -06003628
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003629 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003630}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003631
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003632void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003633 for (const auto &layout_map_entry : pCB->image_layout_map) {
3634 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003635 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003636 const auto *image_state = GetImageState(image);
3637 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003638 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3639 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003640 }
3641}
3642
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003643// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003644// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3645// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003646bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3647 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003648 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003649 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003650 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3651
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003652 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07003653 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
3654 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003655 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003656 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3657 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3658 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003659 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
3660 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3661 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07003662 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3663 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
3664 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
3665 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3666 string_VkImageLayout(first_layout));
3667 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3668 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003669 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3670 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3671 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003672 }
3673 }
sfricke-samsung55f01952020-03-24 08:16:41 -07003674
3675 // Same as above for loadOp, but for stencilLoadOp
3676 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3677 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3678 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3679 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
3680 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
3681 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3682 string_VkImageLayout(first_layout));
3683 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3684 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
3685 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
3686 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3687 string_VkImageLayout(first_layout));
3688 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3689 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3690 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
3691 "Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003692 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003693 }
3694 }
3695
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003696 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003697}
3698
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003699bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3700 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003701 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003702 const char *vuid;
3703 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003704
Jason Ekstranda1906302017-12-03 20:16:32 -08003705 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3706 VkFormat format = pCreateInfo->pAttachments[i].format;
3707 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3708 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3709 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003710 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
sfricke-samsung6595d272020-05-13 22:43:06 -07003711 "Render pass pAttachment[%u] has loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003712 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3713 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
sfricke-samsung6595d272020-05-13 22:43:06 -07003714 "render pass.",
3715 i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003716 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003717 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
sfricke-samsung6595d272020-05-13 22:43:06 -07003718 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3719 "Render pass pAttachment[%u] has stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3720 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3721 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3722 "render pass.",
3723 i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003724 }
3725 }
3726 }
3727
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003728 // Track when we're observing the first use of an attachment
3729 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3730 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003731 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003732
3733 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3734 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3735 auto attach_index = subpass.pInputAttachments[j].attachment;
3736 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003737 switch (subpass.pInputAttachments[j].layout) {
3738 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3739 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3740 // These are ideal.
3741 break;
3742
3743 case VK_IMAGE_LAYOUT_GENERAL:
3744 // May not be optimal. TODO: reconsider this warning based on other constraints.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003745 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3746 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
Cort Stratton7547f772017-05-04 15:18:52 -07003747 break;
3748
Tobias Hectorbbb12282018-10-22 15:17:59 +01003749 case VK_IMAGE_LAYOUT_UNDEFINED:
3750 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003751 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003752 skip |= LogError(device, vuid,
3753 "Layout for input attachment reference %u in subpass %u is %s but must be "
3754 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3755 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003756 break;
3757
Piers Daniell9af77cd2019-10-16 13:54:12 -06003758 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3759 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3760 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3761 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003762 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003763 skip |= LogError(
3764 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003765 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3766 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3767 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3768 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3769 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003770 skip |= LogError(
3771 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003772 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3773 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3774 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3775 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3776 } else if ((subpass.pInputAttachments[j].aspectMask &
3777 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3778 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3779 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3780 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3781 const auto *attachment_reference_stencil_layout =
3782 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3783 if (attachment_reference_stencil_layout) {
3784 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3785 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3786 attachment_reference_stencil_layout->stencilLayout ==
3787 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3788 attachment_reference_stencil_layout->stencilLayout ==
3789 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3790 attachment_reference_stencil_layout->stencilLayout ==
3791 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3792 attachment_reference_stencil_layout->stencilLayout ==
3793 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3794 attachment_reference_stencil_layout->stencilLayout ==
3795 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3796 attachment_reference_stencil_layout->stencilLayout ==
3797 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3798 attachment_reference_stencil_layout->stencilLayout ==
3799 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3800 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003801 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3802 "In the attachment reference %u in subpass %u with pNext chain instance "
3803 "VkAttachmentReferenceStencilLayoutKHR"
3804 "the stencilLayout member but must not be "
3805 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3806 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3807 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3808 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3809 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3810 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3811 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3812 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3813 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3814 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003815 }
3816 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003817 skip |= LogError(
3818 device, "VUID-VkAttachmentReference2-attachment-03315",
3819 "When the layout for input attachment reference %u in subpass %u is "
3820 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3821 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3822 "VkAttachmentReferenceStencilLayout instance.",
3823 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003824 }
3825 }
3826 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3827 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3828 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003829 skip |= LogError(
3830 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003831 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3832 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3833 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3834 j, i);
3835 }
3836 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3837 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3838 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003839 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3840 "When the aspectMask for input attachment reference %u in subpass %u is "
3841 "VK_IMAGE_ASPECT_STENCIL_BIT "
3842 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3843 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3844 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003845 }
3846 }
3847 break;
3848
Graeme Leese668a9862018-10-08 10:40:02 +01003849 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3850 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003851 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003852 break;
3853 } else {
3854 // Intentionally fall through to generic error message
3855 }
3856 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003857
Cort Stratton7547f772017-05-04 15:18:52 -07003858 default:
3859 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003860 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3861 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3862 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003863 }
3864
Cort Stratton7547f772017-05-04 15:18:52 -07003865 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003866 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3867 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003868
3869 bool used_as_depth =
3870 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3871 bool used_as_color = false;
3872 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3873 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3874 }
3875 if (!used_as_depth && !used_as_color &&
3876 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003877 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003878 skip |= LogError(device, vuid,
3879 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
Mark Lobodzinski6ff146b2020-05-22 14:37:05 -06003880 function_name, attach_index, i);
Cort Stratton7547f772017-05-04 15:18:52 -07003881 }
3882 }
3883 attach_first_use[attach_index] = false;
3884 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003885
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003886 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3887 auto attach_index = subpass.pColorAttachments[j].attachment;
3888 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3889
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003890 // TODO: Need a way to validate shared presentable images here, currently just allowing
3891 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3892 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003893 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003894 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003895 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003896 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3897 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003898 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003899
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003900 case VK_IMAGE_LAYOUT_GENERAL:
3901 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003902 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3903 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003904 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003905
Tobias Hectorbbb12282018-10-22 15:17:59 +01003906 case VK_IMAGE_LAYOUT_UNDEFINED:
3907 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003908 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003909 skip |= LogError(device, vuid,
3910 "Layout for color attachment reference %u in subpass %u is %s but should be "
3911 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3912 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003913 break;
3914
Piers Daniell9af77cd2019-10-16 13:54:12 -06003915 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3916 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3917 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3918 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003919 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003920 skip |= LogError(
3921 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003922 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3923 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3924 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3925 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3926 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003927 skip |= LogError(
3928 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003929 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3930 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3931 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3932 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3933 } else if ((subpass.pColorAttachments[j].aspectMask &
3934 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3935 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3936 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3937 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3938 const auto *attachment_reference_stencil_layout =
3939 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3940 if (attachment_reference_stencil_layout) {
3941 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3942 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3943 attachment_reference_stencil_layout->stencilLayout ==
3944 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3945 attachment_reference_stencil_layout->stencilLayout ==
3946 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3947 attachment_reference_stencil_layout->stencilLayout ==
3948 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3949 attachment_reference_stencil_layout->stencilLayout ==
3950 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3951 attachment_reference_stencil_layout->stencilLayout ==
3952 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3953 attachment_reference_stencil_layout->stencilLayout ==
3954 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3955 attachment_reference_stencil_layout->stencilLayout ==
3956 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3957 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003958 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3959 "In the attachment reference %u in subpass %u with pNext chain instance "
3960 "VkAttachmentReferenceStencilLayoutKHR"
3961 "the stencilLayout member but must not be "
3962 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3963 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3964 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3965 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3966 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3967 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3968 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3969 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3970 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3971 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003972 }
3973 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003974 skip |= LogError(
3975 device, "VUID-VkAttachmentReference2-attachment-03315",
3976 "When the layout for color attachment reference %u in subpass %u is "
3977 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3978 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3979 "VkAttachmentReferenceStencilLayout instance.",
3980 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003981 }
3982 }
3983 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3984 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3985 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003986 skip |= LogError(
3987 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003988 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3989 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3990 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3991 j, i);
3992 }
3993 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3994 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3995 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003996 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3997 "When the aspectMask for color attachment reference %u in subpass %u is "
3998 "VK_IMAGE_ASPECT_STENCIL_BIT "
3999 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4000 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
4001 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004002 }
4003 }
4004 break;
4005
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004006 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004007 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
4008 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
4009 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004010 }
4011
John Zulauf4eee2692019-02-09 16:14:25 -07004012 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
4013 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
4014 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08004015 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004016 skip |= LogError(device, vuid,
4017 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
4018 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
4019 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004020 }
4021
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004022 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004023 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
4024 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004025 }
4026 attach_first_use[attach_index] = false;
4027 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004028
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004029 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
4030 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004031 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
4032 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
4033 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06004034 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06004035
Dave Houltona9df0ce2018-02-07 10:51:23 -07004036 case VK_IMAGE_LAYOUT_GENERAL:
4037 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
4038 // doing a bunch of transitions.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004039 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
4040 "GENERAL layout for depth attachment may not give optimal performance.");
Dave Houltona9df0ce2018-02-07 10:51:23 -07004041 break;
4042
Tobias Hectorbbb12282018-10-22 15:17:59 +01004043 case VK_IMAGE_LAYOUT_UNDEFINED:
4044 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004045 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004046 skip |= LogError(device, vuid,
4047 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
4048 "layout or GENERAL.",
4049 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004050 break;
4051
Piers Daniell9af77cd2019-10-16 13:54:12 -06004052 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4053 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4054 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4055 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004056 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004057 skip |= LogError(
4058 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004059 "Layout for depth attachment reference in subpass %u is %s but must not be "
4060 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4061 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4062 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
4063 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004064 skip |= LogError(
4065 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004066 "Layout for depth attachment reference in subpass %u is %s but must not be "
4067 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4068 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4069 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
4070 } else if ((subpass.pDepthStencilAttachment->aspectMask &
4071 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4072 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4073 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4074 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4075 const auto *attachment_reference_stencil_layout =
4076 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
4077 if (attachment_reference_stencil_layout) {
4078 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4079 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4080 attachment_reference_stencil_layout->stencilLayout ==
4081 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4082 attachment_reference_stencil_layout->stencilLayout ==
4083 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4084 attachment_reference_stencil_layout->stencilLayout ==
4085 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4086 attachment_reference_stencil_layout->stencilLayout ==
4087 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4088 attachment_reference_stencil_layout->stencilLayout ==
4089 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4090 attachment_reference_stencil_layout->stencilLayout ==
4091 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4092 attachment_reference_stencil_layout->stencilLayout ==
4093 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4094 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004095 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
4096 "In the attachment reference in subpass %u with pNext chain instance "
4097 "VkAttachmentReferenceStencilLayoutKHR"
4098 "the stencilLayout member but must not be "
4099 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4100 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4101 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4102 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4103 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4104 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4105 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4106 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4107 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
4108 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004109 }
4110 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004111 skip |= LogError(
4112 device, "VUID-VkAttachmentReference2-attachment-03315",
4113 "When the layout for depth attachment reference in subpass %u is "
4114 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4115 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4116 "VkAttachmentReferenceStencilLayout instance.",
4117 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004118 }
4119 }
4120 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4121 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4122 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004123 skip |= LogError(
4124 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004125 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
4126 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4127 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4128 i);
4129 }
4130 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4131 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4132 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004133 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
4134 "When the aspectMask for depth attachment reference in subpass %u is "
4135 "VK_IMAGE_ASPECT_STENCIL_BIT "
4136 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4137 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
4138 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004139 }
4140 }
4141 break;
4142
Dave Houltona9df0ce2018-02-07 10:51:23 -07004143 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4144 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004145 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004146 break;
4147 } else {
4148 // Intentionally fall through to generic error message
4149 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004150 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004151
Dave Houltona9df0ce2018-02-07 10:51:23 -07004152 default:
4153 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004154 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
4155 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4156 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
4157 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004158 }
4159
4160 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4161 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004162 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4163 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004164 }
4165 attach_first_use[attach_index] = false;
4166 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004167 }
4168 return skip;
4169}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004170
Mark Lobodzinski96210742017-02-09 10:33:46 -07004171// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4172// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004173template <typename T1>
4174bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4175 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4176 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004177 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004178 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004179 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004180 if (strict) {
4181 correct_usage = ((actual & desired) == desired);
4182 } else {
4183 correct_usage = ((actual & desired) != 0);
4184 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004185
Mark Lobodzinski96210742017-02-09 10:33:46 -07004186 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004187 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004188 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004189 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
4190 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4191 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004192 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004193 skip = LogError(object, msgCode,
4194 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4195 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004196 }
4197 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004198 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004199}
4200
4201// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4202// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004203bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004204 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004205 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004206 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004207}
4208
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004209bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004210 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004211 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004212 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4213 if ((image_format_features & desired) != desired) {
4214 // Same error, but more details if it was an AHB external format
4215 if (image_state->has_ahb_format == true) {
4216 skip |= LogError(image_state->image, vuid,
4217 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4218 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4219 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004220 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004221 } else {
4222 skip |= LogError(image_state->image, vuid,
4223 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4224 "with tiling %s.",
4225 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4226 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4227 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004228 }
4229 }
4230 return skip;
4231}
4232
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004233bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004234 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004235 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004236 // layerCount must not be zero
4237 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004238 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4239 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004240 }
4241 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4242 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004243 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4244 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004245 }
4246 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4247 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4248 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004249 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4250 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4251 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4252 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004253 }
4254 return skip;
4255}
4256
Mark Lobodzinski96210742017-02-09 10:33:46 -07004257// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4258// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004259bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004260 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004261 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004262 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004263}
4264
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004265bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004266 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004267 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004268
4269 const VkDeviceSize &range = pCreateInfo->range;
4270 if (range != VK_WHOLE_SIZE) {
4271 // Range must be greater than 0
4272 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004273 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
4274 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4275 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4276 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004277 }
4278 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004279 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4280 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004281 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
4282 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4283 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4284 "(%" PRIu32 ").",
4285 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004286 }
4287 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004288 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004289 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
4290 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4291 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4292 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4293 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004294 }
4295 // The sum of range and offset must be less than or equal to the size of buffer
4296 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004297 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
4298 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4299 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4300 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4301 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004302 }
4303 }
4304 return skip;
4305}
4306
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004307bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004308 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004309 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004310 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4311 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004312 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
4313 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4314 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004315 }
4316 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4317 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004318 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
4319 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4320 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004321 }
4322 return skip;
4323}
4324
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004325bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004326 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004327 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004328
Dave Houltond8ed0212018-05-16 17:18:24 -06004329 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004330
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004331 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004332 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4333 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4334 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004335 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004336
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004337 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004338 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4339 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4340 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004341 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004342
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004343 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004344 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4345 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4346 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004347 }
Jeff Bolz87697532019-01-11 22:54:00 -06004348
4349 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4350 if (chained_devaddr_struct) {
4351 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4352 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004353 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4354 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4355 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004356 }
4357 }
4358
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004359 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4360 if (chained_opaqueaddr_struct) {
4361 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4362 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004363 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4364 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4365 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004366 }
4367 }
4368
Shannon McPherson4984e642019-12-05 13:04:34 -07004369 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004370 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4371 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004372 skip |= LogError(
4373 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004374 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4375 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4376 }
4377
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004378 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004379 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4380 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4381 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004382 }
4383
Mark Lobodzinski96210742017-02-09 10:33:46 -07004384 return skip;
4385}
4386
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004387bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004388 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004389 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004390 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004391 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4392 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004393 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004394 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4395 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004396 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004397 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4398 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4399 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004400
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004401 // Buffer view offset must be less than the size of buffer
4402 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004403 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
4404 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4405 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4406 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004407 }
4408
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004409 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004410 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4411 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4412 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004413 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4414 : "VUID-VkBufferViewCreateInfo-offset-00926";
4415 skip |= LogError(buffer_state->buffer, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004416 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4417 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4418 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004419 }
4420
4421 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4422 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4423 if ((elementSize % 3) == 0) {
4424 elementSize /= 3;
4425 }
4426 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4427 VkDeviceSize alignmentRequirement =
4428 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4429 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4430 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4431 }
4432 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004433 skip |= LogError(
4434 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004435 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4436 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4437 ") must be a multiple of the lesser of "
4438 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4439 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4440 "(%" PRId32
4441 ") is VK_TRUE, the size of a texel of the requested format. "
4442 "If the size of a texel is a multiple of three bytes, then the size of a "
4443 "single component of format is used instead",
4444 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4445 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4446 }
4447 }
4448 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4449 VkDeviceSize alignmentRequirement =
4450 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4451 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4452 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4453 }
4454 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004455 skip |= LogError(
4456 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004457 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4458 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4459 ") must be a multiple of the lesser of "
4460 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4461 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4462 "(%" PRId32
4463 ") is VK_TRUE, the size of a texel of the requested format. "
4464 "If the size of a texel is a multiple of three bytes, then the size of a "
4465 "single component of format is used instead",
4466 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4467 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4468 }
4469 }
4470 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004471
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004472 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004473
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004474 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004475 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004476 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004477}
4478
Mark Lobodzinski602de982017-02-09 11:01:33 -07004479// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004480bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004481 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004482 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004483 const IMAGE_STATE *image_state = GetImageState(image);
4484 // checks color format and (single-plane or non-disjoint)
4485 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004486 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004487 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004488 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 -07004489 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004490 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 -07004491 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004492 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004493 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004494 skip |= LogError(image, vuid,
4495 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4496 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4497 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004498 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004499 skip |= LogError(image, vuid,
4500 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4501 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4502 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004503 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004504 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004505 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004506 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 -07004507 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004508 skip |=
4509 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 -07004510 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004511 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004512 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004513 skip |=
4514 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 -07004515 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004516 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4517 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004518 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004519 } else if (FormatIsMultiplane(format)) {
4520 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4521 if (3 == FormatPlaneCount(format)) {
4522 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4523 }
4524 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004525 skip |=
4526 LogError(image, vuid,
4527 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4528 "set, where n = [0, 1, 2].",
4529 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004530 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004531 }
4532 return skip;
4533}
4534
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004535bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4536 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004537 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4538 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004539 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004540
4541 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004542 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004543 skip |= LogError(image, errorCodes.base_mip_err,
4544 "%s: %s.baseMipLevel (= %" PRIu32
4545 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4546 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004547 }
Petr Kraus4d718682017-05-18 03:38:41 +02004548
Petr Krausffa94af2017-08-08 21:46:02 +02004549 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4550 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004551 skip |=
4552 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004553 } else {
4554 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004555
Petr Krausffa94af2017-08-08 21:46:02 +02004556 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004557 skip |= LogError(image, errorCodes.mip_count_err,
4558 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4559 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4560 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4561 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004562 }
Petr Kraus4d718682017-05-18 03:38:41 +02004563 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004564 }
Petr Kraus4d718682017-05-18 03:38:41 +02004565
4566 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004567 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004568 skip |= LogError(image, errorCodes.base_layer_err,
4569 "%s: %s.baseArrayLayer (= %" PRIu32
4570 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4571 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004572 }
Petr Kraus4d718682017-05-18 03:38:41 +02004573
Petr Krausffa94af2017-08-08 21:46:02 +02004574 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4575 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004576 skip |=
4577 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004578 } else {
4579 const uint64_t necessary_layer_count =
4580 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004581
Petr Krausffa94af2017-08-08 21:46:02 +02004582 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004583 skip |= LogError(image, errorCodes.layer_count_err,
4584 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4585 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4586 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4587 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004588 }
Petr Kraus4d718682017-05-18 03:38:41 +02004589 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004590 }
Petr Kraus4d718682017-05-18 03:38:41 +02004591
Mark Lobodzinski602de982017-02-09 11:01:33 -07004592 return skip;
4593}
4594
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004595bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004596 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004597 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004598 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4599 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4600 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4601
4602 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4603 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4604
4605 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004606 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4607 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004608 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004609 : "VUID-VkImageViewCreateInfo-image-01482")
4610 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4611 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004612 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004613 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4614 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004615
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004616 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004617 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004618 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004619}
4620
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004621bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004622 const VkImageSubresourceRange &subresourceRange,
4623 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004624 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004625 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4626 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4627 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4628 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004629
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004630 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004631 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004632 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004633}
4634
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004635bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004636 const VkImageSubresourceRange &subresourceRange,
4637 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004638 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004639 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4640 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4641 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4642 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004643
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004644 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004645 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4646 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004647}
4648
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004649bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004650 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004651 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004652 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004653 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4654 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4655 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4656 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004657
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004658 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004659 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004660}
4661
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004662bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4663 const VkImageUsageFlags image_usage) const {
4664 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4665 bool skip = false;
4666
4667 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4668 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4669
4670 if (image_state->has_ahb_format == true) {
4671 // AHB image view and image share same feature sets
4672 tiling_features = image_state->format_features;
4673 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4674 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4675 assert(device_extensions.vk_ext_image_drm_format_modifier);
4676 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4677 nullptr};
4678 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4679
4680 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4681 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4682 nullptr};
4683 format_properties_2.pNext = (void *)&drm_properties_list;
4684 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4685
4686 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4687 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4688 0) {
4689 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4690 }
4691 }
4692 } else {
4693 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4694 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4695 : format_properties.optimalTilingFeatures;
4696 }
4697
4698 if (tiling_features == 0) {
4699 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4700 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4701 "physical device.",
4702 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4703 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4704 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4705 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4706 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4707 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4708 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4709 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4710 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4711 "VK_IMAGE_USAGE_STORAGE_BIT.",
4712 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4713 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4714 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4715 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4716 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4717 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4718 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4719 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4720 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4721 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4722 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4723 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4724 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4725 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4726 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4727 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4728 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4729 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4730 }
4731
4732 return skip;
4733}
4734
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004735bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004736 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004737 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004738 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004739 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004740 skip |=
4741 ValidateImageUsageFlags(image_state,
4742 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4743 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4744 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4745 false, kVUIDUndefined, "vkCreateImageView()",
4746 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4747 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004748 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004749 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004750 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004751 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004752 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004753 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004754
4755 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4756 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004757 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004758 VkFormat view_format = pCreateInfo->format;
4759 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004760 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004761 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004762
Dave Houltonbd2e2622018-04-10 16:41:14 -06004763 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004764 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004765 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004766 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004767 if (!device_extensions.vk_ext_separate_stencil_usage) {
4768 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004769 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4770 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4771 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004772 }
4773 } else {
4774 const auto image_stencil_struct =
4775 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4776 if (image_stencil_struct == nullptr) {
4777 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004778 skip |= LogError(
4779 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004780 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4781 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4782 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4783 }
4784 } else {
4785 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4786 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4787 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004788 skip |= LogError(
4789 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004790 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4791 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4792 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4793 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4794 }
4795 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4796 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004797 skip |= LogError(
4798 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004799 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4800 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4801 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4802 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4803 }
4804 }
4805 }
4806 }
4807
Dave Houltonbd2e2622018-04-10 16:41:14 -06004808 image_usage = chained_ivuci_struct->usage;
4809 }
4810
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004811 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4812 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004813 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004814 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004815 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004816 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004817 std::stringstream ss;
4818 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004819 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004820 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004821 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004822 }
4823 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004824 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06004825 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4826 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004827 const char *error_vuid;
4828 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4829 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4830 } else if ((device_extensions.vk_khr_maintenance2) &&
4831 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4832 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4833 } else if ((!device_extensions.vk_khr_maintenance2) &&
4834 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4835 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4836 } else {
4837 // both enabled
4838 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4839 }
Dave Houltonc7988072018-04-16 11:46:56 -06004840 std::stringstream ss;
4841 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004842 << " is not in the same format compatibility class as "
4843 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004844 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4845 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004846 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004847 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004848 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004849 }
4850 } else {
4851 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004852 // Unless it is a multi-planar color bit aspect
4853 if ((image_format != view_format) &&
4854 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4855 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4856 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004857 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004858 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004859 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004860 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004861 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004862 }
4863 }
4864
4865 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004866 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004867
4868 switch (image_type) {
4869 case VK_IMAGE_TYPE_1D:
4870 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004871 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4872 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4873 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004874 }
4875 break;
4876 case VK_IMAGE_TYPE_2D:
4877 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4878 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4879 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004880 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4881 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4882 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004883 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004884 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4885 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4886 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004887 }
4888 }
4889 break;
4890 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004891 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004892 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4893 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4894 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004895 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004896 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4897 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4898 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004899 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4900 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004901 skip |= LogError(
4902 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4903 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4904 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4905 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4906 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004907 }
4908 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004909 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4910 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4911 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004912 }
4913 }
4914 } else {
4915 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004916 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4917 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4918 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004919 }
4920 }
4921 break;
4922 default:
4923 break;
4924 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004925
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004926 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004927 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004928 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004929 }
4930
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004931 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004932
Jeff Bolz9af91c52018-09-01 21:53:57 -05004933 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4934 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004935 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4936 "vkCreateImageView() If image was created with usage containing "
4937 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4938 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004939 }
4940 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004941 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4942 "vkCreateImageView() If image was created with usage containing "
4943 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004944 }
4945 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05004946
4947 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
4948 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
4949 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
4950 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
4951 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
4952 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
4953 }
4954 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
4955 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
4956 skip |= LogError(
4957 device, "VUID-VkImageViewCreateInfo-viewType-02963",
4958 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
4959 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
4960 }
4961 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004962
4963 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
4964 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06004965 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004966 "vkCreateImageView(): If image was created with usage containing "
4967 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
4968 pCreateInfo->subresourceRange.levelCount);
4969 }
4970 }
4971 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
4972 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06004973 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004974 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
4975 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
4976 }
4977 } else {
4978 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
4979 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
4980 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
4981 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02573",
4982 "vkCreateImageView(): If image was created with usage containing "
4983 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
4984 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
4985 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
4986 }
4987 }
4988 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004989 }
4990 return skip;
4991}
4992
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004993bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4994 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004995 bool skip = false;
4996
4997 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4998 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4999 VkDeviceSize src_min = UINT64_MAX;
5000 VkDeviceSize src_max = 0;
5001 VkDeviceSize dst_min = UINT64_MAX;
5002 VkDeviceSize dst_max = 0;
5003
5004 for (uint32_t i = 0; i < regionCount; i++) {
5005 src_min = std::min(src_min, pRegions[i].srcOffset);
5006 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5007 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5008 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5009
5010 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5011 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005012 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
5013 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
5014 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5015 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005016 }
5017
5018 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5019 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005020 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
5021 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
5022 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5023 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005024 }
5025
5026 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5027 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005028 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
5029 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5030 ") is greater than the source buffer size (%" PRIuLEAST64
5031 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
5032 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005033 }
5034
5035 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5036 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005037 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
5038 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5039 ") is greater than the destination buffer size (%" PRIuLEAST64
5040 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
5041 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005042 }
5043 }
5044
5045 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5046 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5047 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005048 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
5049 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005050 }
5051 }
5052
5053 return skip;
5054}
5055
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005056bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005057 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005058 const auto cb_node = GetCBState(commandBuffer);
5059 const auto src_buffer_state = GetBufferState(srcBuffer);
5060 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005061
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005062 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005063 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5064 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005065 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005066 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005067 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5068 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005069 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005070 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5071 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005072 skip |=
5073 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5074 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005075 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5076 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005077 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005078 return skip;
5079}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005080
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005081bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005082 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005083 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005084 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005085 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
5086 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005087 } else {
5088 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005089 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5090 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005091 }
5092 }
5093 return skip;
5094}
5095
Jeff Bolz5c801d12019-10-09 10:38:45 -05005096bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5097 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005098 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005099 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005100
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005101 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005102 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005103 skip |=
5104 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005105 }
5106 return skip;
5107}
5108
Jeff Bolz5c801d12019-10-09 10:38:45 -05005109bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005110 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005111
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005112 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005113 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005114 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005115 }
5116 return skip;
5117}
5118
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005119bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005120 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005121 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005122 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005123 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005124 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005125 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005126 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005127 }
5128 return skip;
5129}
5130
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005131bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005132 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005133 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005134 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005135 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005136 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005137 skip |=
5138 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5139 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005140 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005141 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005142 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5143 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005144 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005145
5146 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005147 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5148 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5149 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5150 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005151 }
5152
5153 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005154 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5155 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5156 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5157 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005158 }
5159
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005160 return skip;
5161}
5162
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005163bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
5164 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005165 bool skip = false;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005166 assert(image_state != nullptr);
5167 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005168
5169 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005170 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005171 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5172 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005173 skip |=
5174 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
5175 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5176 "and 1, respectively.",
5177 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005178 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005179 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005180
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005181 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5182 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005183 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
5184 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
5185 "must be 0 and 1, respectively.",
5186 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005187 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005188 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005189
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005190 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5191 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005192 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
5193 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5194 "For 3D images these must be 0 and 1, respectively.",
5195 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005196 }
5197 }
5198
5199 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005200 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005201 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005202
sfricke-samsung125d2b42020-05-28 06:32:43 -07005203 // If not depth/stencil and not multi-plane
5204 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5205 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
5206 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-bufferOffset-01558"
5207 : "VUID-VkBufferImageCopy-bufferOffset-00193";
5208 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005209 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5210 " must be a multiple of this format's texel size (%" PRIu32 ").",
5211 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005212 }
5213
5214 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06005215 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005216 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00194",
5217 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
5218 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005219 }
5220
5221 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5222 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005223 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005224 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
5225 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5226 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005227 }
5228
5229 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5230 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005231 skip |= LogError(
5232 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005233 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5234 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005235 }
5236
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005237 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005238 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005239 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005240 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 -06005241 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5242 static_cast<int32_t>(adjusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005243 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
5244 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5245 "zero or <= image subresource width (%d).",
5246 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005247 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005248 }
5249
5250 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005251 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 -06005252 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5253 static_cast<int32_t>(adjusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005254 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
5255 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5256 "zero or <= image subresource height (%d).",
5257 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005258 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005259 }
5260
5261 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005262 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 -06005263 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5264 static_cast<int32_t>(adjusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005265 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
5266 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5267 "zero or <= image subresource depth (%d).",
5268 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005269 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005270 }
5271
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005272 // subresource aspectMask must have exactly 1 bit set
5273 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005274 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005275 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005276 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
5277 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005278 }
5279
5280 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005281 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005282 skip |= LogError(
5283 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005284 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
sfricke-samsung125d2b42020-05-28 06:32:43 -07005285 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005286 }
5287
5288 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005289 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5290 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005291
5292 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005293 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005294 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5295 ? "VUID-VkBufferImageCopy-None-01735"
5296 : "VUID-VkBufferImageCopy-bufferRowLength-00203";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005297 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005298 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005299 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5300 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005301 }
5302
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005303 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005304 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005305 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5306 ? "VUID-VkBufferImageCopy-None-01736"
5307 : "VUID-VkBufferImageCopy-bufferImageHeight-00204";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005308 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005309 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005310 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5311 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005312 }
5313
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005314 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005315 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5316 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5317 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005318 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01737"
5319 : "VUID-VkBufferImageCopy-imageOffset-00205";
5320 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005321 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5322 "width & height (%d, %d)..",
5323 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5324 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005325 }
5326
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005327 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005328 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005329 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005330 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5331 ? "VUID-VkBufferImageCopy-None-01738"
5332 : "VUID-VkBufferImageCopy-bufferOffset-00206";
5333 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005334 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5335 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5336 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005337 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005338
5339 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005340 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005341 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005342 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005343 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01739"
5344 : "VUID-VkBufferImageCopy-imageExtent-00207";
5345 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005346 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5347 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5348 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5349 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005350 }
5351
5352 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005353 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005354 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005355 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01740"
5356 : "VUID-VkBufferImageCopy-imageExtent-00208";
5357 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005358 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5359 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5360 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5361 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005362 }
5363
5364 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005365 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005366 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005367 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01741"
5368 : "VUID-VkBufferImageCopy-imageExtent-00209";
5369 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005370 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5371 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5372 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5373 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005374 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005375 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005376
5377 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005378 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005379 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005380 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005381 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5382 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5383 "format has three planes.",
5384 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005385 }
5386
5387 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005388 if (0 ==
5389 (region_aspect_mask & (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 -07005390 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5391 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5392 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5393 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005394 } else {
5395 // Know aspect mask is valid
5396 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5397 const uint32_t compatible_size = FormatElementSize(compatible_format);
5398 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5399 skip |= LogError(
5400 image_state->image, "VUID-VkBufferImageCopy-bufferOffset-01559",
5401 "%s(): pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
5402 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5403 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5404 string_VkFormat(compatible_format));
5405 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005406 }
5407 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005408 }
5409
5410 return skip;
5411}
5412
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005413bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5414 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005415 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005416 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005417
5418 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005419 VkExtent3D extent = pRegions[i].imageExtent;
5420 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005421
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005422 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5423 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005424 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5425 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5426 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005427 }
5428
5429 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5430
5431 // 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 -06005432 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005433 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005434 if (image_extent.width % block_extent.width) {
5435 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5436 }
5437 if (image_extent.height % block_extent.height) {
5438 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5439 }
5440 if (image_extent.depth % block_extent.depth) {
5441 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5442 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005443 }
5444
Dave Houltonfc1a4052017-04-27 14:32:45 -06005445 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005446 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005447 }
5448 }
5449
5450 return skip;
5451}
5452
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005453bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5454 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005455 bool skip = false;
5456
5457 VkDeviceSize buffer_size = buff_state->createInfo.size;
5458
5459 for (uint32_t i = 0; i < regionCount; i++) {
5460 VkExtent3D copy_extent = pRegions[i].imageExtent;
5461
5462 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5463 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005464 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5465 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005466
Tom Cooperb2550c72018-10-15 13:08:41 +01005467 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005468 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005469 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005470 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5471 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5472
5473 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5474 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5475 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005476 }
5477
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005478 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5479 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5480 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005481 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005482 } else {
5483 // Calculate buffer offset of final copied byte, + 1.
5484 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5485 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5486 max_buffer_offset *= unit_size; // convert to bytes
5487 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005488
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005489 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005490 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5491 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005492 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005493 }
5494 }
5495
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005496 return skip;
5497}
5498
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005499bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005500 VkBuffer dstBuffer, uint32_t regionCount,
5501 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005502 const auto cb_node = GetCBState(commandBuffer);
5503 const auto src_image_state = GetImageState(srcImage);
5504 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005505
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005506 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005507
5508 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005509 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005510
5511 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005512 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005513
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005514 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005515
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005516 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005517 skip |=
5518 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5519 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5520 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005521 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005522 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005523 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005524 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005525 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005526
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005527 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005528 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005529 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5530 skip |=
5531 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005532
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005533 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005534 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005535 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5536 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005537 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005538 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5539 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005540
5541 // Validation for VK_EXT_fragment_density_map
5542 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5543 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyImageToBuffer-srcImage-02544",
5544 "vkCmdCopyBufferToImage(): srcImage must not have been created with flags containing "
5545 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5546 }
5547
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005548 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005549 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005550 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005551 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005552 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005553 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005554 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5555 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5556 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005557 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005558 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005559 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005560 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005561 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5562 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005563 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5564 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5565 skip |=
5566 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5567 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5568 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005569 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5570 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005571 }
5572 return skip;
5573}
5574
John Zulauf1686f232019-07-09 16:27:11 -06005575void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5576 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5577 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5578
5579 auto cb_node = GetCBState(commandBuffer);
5580 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005581 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005582 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005583 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005584 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005585}
5586
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005587bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5588 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005589 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005590 const auto cb_node = GetCBState(commandBuffer);
5591 const auto src_buffer_state = GetBufferState(srcBuffer);
5592 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005593
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005594 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005595
5596 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005597 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005598
5599 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005600 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005601 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005602 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005603 skip |=
5604 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5605 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5606 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005607 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005608 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005609 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005610 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005611 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005612 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005613 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005614 skip |=
5615 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5616 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005617 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005618 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5619 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005620 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005621 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5622 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005623
5624 // Validation for VK_EXT_fragment_density_map
5625 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5626 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyBufferToImage-dstImage-02543",
5627 "vkCmdCopyBufferToImage(): dstImage must not have been created with flags containing "
5628 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5629 }
5630
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005631 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005632 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005633 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005634 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005635 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005636 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005637 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5638 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5639 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005640 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005641 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005642 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005643 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005644 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5645 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005646 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5647 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5648 skip |=
5649 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5650 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5651 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005652 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5653 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005654 }
5655 return skip;
5656}
5657
John Zulauf1686f232019-07-09 16:27:11 -06005658void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5659 VkImageLayout dstImageLayout, uint32_t regionCount,
5660 const VkBufferImageCopy *pRegions) {
5661 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5662
5663 auto cb_node = GetCBState(commandBuffer);
5664 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005665 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005666 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005667 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005668 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005669}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005670
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005671bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005672 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005673 bool skip = false;
5674 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5675
Dave Houlton1d960ff2018-01-19 12:17:05 -07005676 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005677 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5678 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5679 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005680 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5681 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005682 }
5683
John Zulaufa26d3c82019-08-14 16:09:08 -06005684 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005685 if (!image_entry) {
5686 return skip;
5687 }
5688
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005689 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5690 if (device_extensions.vk_ext_image_drm_format_modifier) {
5691 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5692 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005693 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5694 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5695 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005696 }
5697 } else {
5698 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005699 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5700 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005701 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005702 }
5703
Dave Houlton1d960ff2018-01-19 12:17:05 -07005704 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005705 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005706 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5707 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5708 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005709 }
5710
Dave Houlton1d960ff2018-01-19 12:17:05 -07005711 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005712 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005713 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5714 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5715 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005716 }
5717
Dave Houlton1d960ff2018-01-19 12:17:05 -07005718 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005719 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005720 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5721 if (FormatIsMultiplane(img_format)) {
5722 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5723 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5724 if (FormatPlaneCount(img_format) > 2u) {
5725 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5726 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5727 }
5728 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005729 skip |= LogError(image, vuid,
5730 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5731 ") must be a single-plane specifier flag.",
5732 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005733 }
5734 } else if (FormatIsColor(img_format)) {
5735 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005736 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5737 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5738 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005739 }
5740 } else if (FormatIsDepthOrStencil(img_format)) {
5741 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5742 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005743 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005744 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5745 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5746 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5747 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005748 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5749 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5750 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005751 }
5752 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005753
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005754 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005755 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005756 }
5757
Mike Weiblen672b58b2017-02-21 14:32:53 -07005758 return skip;
5759}