blob: 6240bbf0af3219f9e4ffcbdfa6a191ac0ea3644a [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) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500256 if (disabled.image_layout_validation) {
257 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)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700850 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03320",
851 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
852 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
853 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700854 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600855 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700856 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700857 }
John Zulauff660ad62019-03-23 07:16:05 -0600858
Petr Krausad0096a2019-08-09 18:35:04 +0200859 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
860 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600861 // TODO: Set memory invalid which is in mem_tracker currently
862 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
863 // subresource.
864 } else if (subresource_map) {
865 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600866 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200867 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700868 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
869 const auto &value = *pos;
870 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700871 subres_skip = LogError(
872 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
John Zulauf5e617452019-11-19 14:44:16 -0700873 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
874 "%s layout is %s.",
875 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
876 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
877 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600878 }
John Zulauf5e617452019-11-19 14:44:16 -0700879 }
John Zulauff660ad62019-03-23 07:16:05 -0600880 skip |= subres_skip;
881 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700882
883 // checks color format and (single-plane or non-disjoint)
884 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
885 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700886 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700887 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
888 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
889 ? "VUID-VkImageMemoryBarrier-image-01671"
890 : "VUID-VkImageMemoryBarrier-image-02902";
891 skip |= LogError(img_barrier.image, vuid,
892 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
893 "but its aspectMask is 0x%" PRIx32 ".",
894 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
895 string_VkFormat(image_format), aspect_mask);
896 }
897 }
898
899 VkImageAspectFlags valid_disjoint_mask =
900 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 -0700901 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700902 ((aspect_mask & valid_disjoint_mask) == 0)) {
903 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
904 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
905 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
906 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
907 string_VkFormat(image_format), aspect_mask);
908 }
909
910 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
911 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
912 "%s: Image barrier %s references %s of format %s has only two planes but included "
913 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
914 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
915 string_VkFormat(image_format), aspect_mask);
916 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700917 }
918 }
919 return skip;
920}
921
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600922bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200923 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700924
Jeff Bolz6835fda2019-10-06 00:15:34 -0500925 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200926 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700927}
928
John Zulauf6b4aae82018-05-09 13:03:36 -0600929template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600930bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
931 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600932 using BarrierRecord = QFOTransferBarrier<Barrier>;
933 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500934 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600935 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
936 const char *barrier_name = BarrierRecord::BarrierName();
937 const char *handle_name = BarrierRecord::HandleName();
938 const char *transfer_type = nullptr;
939 for (uint32_t b = 0; b < barrier_count; b++) {
940 if (!IsTransferOp(&barriers[b])) continue;
941 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700942 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600943 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600944 const auto found = barrier_sets.release.find(barriers[b]);
945 if (found != barrier_sets.release.cend()) {
946 barrier_record = &(*found);
947 transfer_type = "releasing";
948 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600949 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600950 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600951 const auto found = barrier_sets.acquire.find(barriers[b]);
952 if (found != barrier_sets.acquire.cend()) {
953 barrier_record = &(*found);
954 transfer_type = "acquiring";
955 }
956 }
957 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700958 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
959 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
960 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
961 func_name, barrier_name, b, transfer_type, handle_name,
962 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
963 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600964 }
965 }
966 return skip;
967}
968
John Zulaufa4472282019-08-22 14:44:34 -0600969VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
970 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
971}
972
973const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
974 return device_state.GetImageState(barrier.image);
975}
976
977VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
978 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
979}
980
981const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
982 return device_state.GetBufferState(barrier.buffer);
983}
984
985VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
986
John Zulauf6b4aae82018-05-09 13:03:36 -0600987template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600988void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
989 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500990 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600991 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
992 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600993 auto &barrier = barriers[b];
994 if (IsTransferOp(&barrier)) {
995 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
996 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
997 barrier_sets.release.emplace(barrier);
998 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
999 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
1000 barrier_sets.acquire.emplace(barrier);
1001 }
1002 }
1003
1004 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1005 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1006 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1007 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1008 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1009 auto handle_state = BarrierHandleState(*this, barrier);
1010 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1011 if (!mode_concurrent) {
1012 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001013 cb_state->queue_submit_functions.emplace_back(
1014 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1015 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1016 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1017 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001018 });
1019 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001020 }
1021 }
1022}
1023
John Zulaufa4472282019-08-22 14:44:34 -06001024bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001025 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001026 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001027 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001028 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001029 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1030 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001031 return skip;
1032}
1033
John Zulaufa4472282019-08-22 14:44:34 -06001034void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1035 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1036 const VkImageMemoryBarrier *pImageMemBarriers) {
1037 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1038 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001039}
1040
1041template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001042bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001043 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001044 // Record to the scoreboard or report that we have a duplication
1045 bool skip = false;
1046 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1047 if (!inserted.second && inserted.first->second != cb_state) {
1048 // 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 -06001049 LogObjectList objlist(cb_state->commandBuffer);
1050 objlist.add(barrier.handle);
1051 objlist.add(inserted.first->second->commandBuffer);
1052 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001053 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1054 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1055 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1056 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1057 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001058 }
1059 return skip;
1060}
1061
1062template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001063bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1064 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001065 using BarrierRecord = QFOTransferBarrier<Barrier>;
1066 using TypeTag = typename BarrierRecord::Tag;
1067 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001068 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001069 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001070 const char *barrier_name = BarrierRecord::BarrierName();
1071 const char *handle_name = BarrierRecord::HandleName();
1072 // No release should have an extant duplicate (WARNING)
1073 for (const auto &release : cb_barriers.release) {
1074 // Check the global pending release barriers
1075 const auto set_it = global_release_barriers.find(release.handle);
1076 if (set_it != global_release_barriers.cend()) {
1077 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1078 const auto found = set_for_handle.find(release);
1079 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001080 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1081 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1082 " to dstQueueFamilyIndex %" PRIu32
1083 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1084 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1085 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001086 }
1087 }
1088 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1089 }
1090 // Each acquire must have a matching release (ERROR)
1091 for (const auto &acquire : cb_barriers.acquire) {
1092 const auto set_it = global_release_barriers.find(acquire.handle);
1093 bool matching_release_found = false;
1094 if (set_it != global_release_barriers.cend()) {
1095 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1096 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1097 }
1098 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001099 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1100 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1101 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1102 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1103 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001104 }
1105 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1106 }
1107 return skip;
1108}
1109
John Zulauf3b04ebd2019-07-18 14:08:11 -06001110bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001111 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001112 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001113 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001114 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1115 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001116 return skip;
1117}
1118
1119template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001120void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001121 using BarrierRecord = QFOTransferBarrier<Barrier>;
1122 using TypeTag = typename BarrierRecord::Tag;
1123 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001124 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001125
1126 // Add release barriers from this submit to the global map
1127 for (const auto &release : cb_barriers.release) {
1128 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1129 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1130 global_release_barriers[release.handle].insert(release);
1131 }
1132
1133 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1134 for (const auto &acquire : cb_barriers.acquire) {
1135 // NOTE: We're not using [] because we don't want to create entries for missing releases
1136 auto set_it = global_release_barriers.find(acquire.handle);
1137 if (set_it != global_release_barriers.end()) {
1138 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1139 set_for_handle.erase(acquire);
1140 if (set_for_handle.size() == 0) { // Clean up empty sets
1141 global_release_barriers.erase(set_it);
1142 }
1143 }
1144 }
1145}
1146
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001147void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001148 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1149 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001150}
1151
John Zulauf6b4aae82018-05-09 13:03:36 -06001152// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001153void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001154
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001155void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001156 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001157 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001158 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001159
Chris Forbes4de4b132017-08-21 11:27:08 -07001160 // For ownership transfers, the barrier is specified twice; as a release
1161 // operation on the yielding queue family, and as an acquire operation
1162 // on the acquiring queue family. This barrier may also include a layout
1163 // transition, which occurs 'between' the two operations. For validation
1164 // purposes it doesn't seem important which side performs the layout
1165 // transition, but it must not be performed twice. We'll arbitrarily
1166 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001167 //
1168 // However, we still need to record initial layout for the "initial layout" validation
1169 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001170
Petr Krausad0096a2019-08-09 18:35:04 +02001171 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001172 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001173 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001174 }
1175}
1176
unknown86bcb3a2019-07-11 13:05:36 -06001177void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001178 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001179 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1180 const auto &image_create_info = image_state->createInfo;
1181
1182 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1183 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1184 // for all (potential) layer sub_resources.
1185 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1186 normalized_isr.baseArrayLayer = 0;
1187 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1188 }
1189
Michael Spang8af7c102020-05-03 20:50:09 -04001190 VkImageLayout initial_layout = mem_barrier.oldLayout;
1191
1192 // Layout transitions in external instance are not tracked, so don't validate initial layout.
1193 if (QueueFamilyIsSpecial(mem_barrier.srcQueueFamilyIndex)) {
1194 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1195 }
1196
John Zulauf2be3fe02019-12-30 09:48:02 -07001197 if (is_release_op) {
1198 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1199 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001200 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001201 }
unknown86bcb3a2019-07-11 13:05:36 -06001202}
1203
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001204bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1205 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1206 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1207 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001208 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001209 assert(cb_node);
1210 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001211 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001212 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001213
John Zulauff660ad62019-03-23 07:16:05 -06001214 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1215 if (subresource_map) {
1216 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001217 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001218 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1219 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001220 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001221 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1222 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1223 "%s layout %s.",
1224 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1225 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1226 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001227 }
John Zulauf5e617452019-11-19 14:44:16 -07001228 }
John Zulauff660ad62019-03-23 07:16:05 -06001229 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001230 }
John Zulauff660ad62019-03-23 07:16:05 -06001231
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001232 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1233 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1234 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001235 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1236 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001237 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1238 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1239 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001240 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001241 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001242 if (image_state->shared_presentable) {
1243 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001244 skip |= LogError(device, layout_invalid_msg_code,
1245 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1246 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001247 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001248 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001249 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001250 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001251 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1252 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1253 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1254 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001255 }
1256 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001257 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001258}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001259bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001260 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1261 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001262 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001263 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1264 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1265}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001266
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001267void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001268 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001269 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001270 if (!renderPass) return;
1271
Tobias Hectorbbb12282018-10-22 15:17:59 +01001272 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001273 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001274 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001275 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001276 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1277 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1278 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1279 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001280 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001281 }
John Zulauf8e308292018-09-21 11:34:37 -06001282 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001283 VkImageLayout stencil_layout = kInvalidLayout;
1284 const auto *attachment_description_stencil_layout =
1285 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1286 if (attachment_description_stencil_layout) {
1287 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1288 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001289 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001290 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001291 }
1292 }
1293}
Dave Houltone19e20d2018-02-02 16:32:41 -07001294
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001295#ifdef VK_USE_PLATFORM_ANDROID_KHR
1296// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1297// This could also move into a seperate core_validation_android.cpp file... ?
1298
1299//
1300// AHB-specific validation within non-AHB APIs
1301//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001302bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001303 bool skip = false;
1304
1305 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1306 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001307 if (0 != ext_fmt_android->externalFormat) {
1308 if (VK_FORMAT_UNDEFINED != create_info->format) {
1309 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001310 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1311 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1312 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001313 }
1314
1315 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001316 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1317 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1318 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001319 }
1320
1321 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001322 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1323 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001324 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1325 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1326 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001327 }
1328
1329 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001330 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1331 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1332 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001333 }
1334 }
1335
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001336 if ((0 != ext_fmt_android->externalFormat) &&
1337 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001338 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001339 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1340 ") which has "
1341 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1342 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001343 }
1344 }
1345
Dave Houltond9611312018-11-19 17:03:36 -07001346 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001347 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001348 skip |=
1349 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1350 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1351 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001352 }
1353 }
1354
1355 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1356 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1357 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001358 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001359 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1360 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1361 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1362 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001363 }
1364
1365 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001366 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1367 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1368 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1369 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1370 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001371 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001372 }
1373
1374 return skip;
1375}
1376
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001377bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001378 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001379 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001380
1381 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001382 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001383 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1384 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001385 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001386 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001387 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001388
Dave Houltond9611312018-11-19 17:03:36 -07001389 // Chain must include a compatible ycbcr conversion
1390 bool conv_found = false;
1391 uint64_t external_format = 0;
1392 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1393 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001394 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001395 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001396 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001397 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001398 }
Dave Houltond9611312018-11-19 17:03:36 -07001399 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001400 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001401 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001402 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1403 "an externalFormat (%" PRIu64
1404 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1405 "with the same external format.",
1406 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001407 }
1408
1409 // Errors in create_info swizzles
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001410 if (((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1411 (create_info->components.r != VK_COMPONENT_SWIZZLE_R)) ||
1412 ((create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1413 (create_info->components.g != VK_COMPONENT_SWIZZLE_G)) ||
1414 ((create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1415 (create_info->components.b != VK_COMPONENT_SWIZZLE_B)) ||
1416 ((create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY) &&
1417 (create_info->components.a != VK_COMPONENT_SWIZZLE_A))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001418 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1419 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1420 "includes one or more non-identity component swizzles.");
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
John Zulauf07288512019-07-05 11:09:50 -06001757bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001758 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001759
1760 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1761 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001762 skip |= LogError(image_state->image, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001763 }
1764
Dave Houlton1d2022c2017-03-29 11:43:58 -06001765 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001766 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001767 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001768 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001769 char const str[] = "vkCmdClearColorImage called with compressed image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001770 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001771 }
1772
1773 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1774 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001775 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001776 }
1777 return skip;
1778}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001779
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001780uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1781 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1782 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001783 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001784 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001785 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001786 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001787}
1788
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001789uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1790 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1791 uint32_t array_layer_count = range->layerCount;
1792 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1793 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001794 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001795 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001796}
1797
John Zulauf07288512019-07-05 11:09:50 -06001798bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1799 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1800 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001801 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001802 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1803 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001804 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1805 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1806 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001807 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001808
1809 } else {
1810 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1811 if (!device_extensions.vk_khr_shared_presentable_image) {
1812 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001813 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1814 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1815 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001816 }
1817 } else {
1818 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1819 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001820 skip |= LogError(
1821 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001822 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1823 func_name, string_VkImageLayout(dest_image_layout));
1824 }
1825 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001826 }
1827
John Zulauff660ad62019-03-23 07:16:05 -06001828 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001829 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001830 if (subresource_map) {
1831 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001832 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001833 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001834 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1835 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001836 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1837 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1838 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1839 } else {
1840 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001841 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001842 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1843 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1844 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1845 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001846 }
John Zulauf5e617452019-11-19 14:44:16 -07001847 }
John Zulauff660ad62019-03-23 07:16:05 -06001848 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001849 }
1850
1851 return skip;
1852}
1853
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001854bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1855 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001856 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001857 bool skip = false;
1858 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001859 const auto *cb_node = GetCBState(commandBuffer);
1860 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001861 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001862 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001863 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001864 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001865 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001866 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001867 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1868 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001869 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001870 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001871 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001872 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001873 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001874 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1875 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001876 }
sfricke-samsunge775d492020-02-28 09:02:25 -08001877 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
1878 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
1879 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
1880 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
1881 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
1882 string_VkFormat(image_state->createInfo.format));
1883 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001884 }
1885 return skip;
1886}
1887
John Zulaufeabb4462019-07-05 14:13:03 -06001888void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1889 const VkClearColorValue *pColor, uint32_t rangeCount,
1890 const VkImageSubresourceRange *pRanges) {
1891 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1892
1893 auto cb_node = GetCBState(commandBuffer);
1894 auto image_state = GetImageState(image);
1895 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001896 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001897 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001898 }
1899 }
1900}
1901
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001902bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1903 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001904 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001905 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001906
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001907 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001908 const auto *cb_node = GetCBState(commandBuffer);
1909 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001910 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001911 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001912 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001913 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001914 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001915 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001916 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001917 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001918 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001919 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001920 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001921
1922 bool any_include_aspect_depth_bit = false;
1923 bool any_include_aspect_stencil_bit = false;
1924
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001925 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001926 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001927 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001928 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001929 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001930 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1931 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001932 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001933 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1934 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001935 skip |= LogError(commandBuffer, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001936 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001937 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1938 any_include_aspect_depth_bit = true;
1939 }
1940 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1941 any_include_aspect_stencil_bit = true;
1942 }
1943 }
1944 if (any_include_aspect_stencil_bit) {
1945 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1946 if (image_stencil_struct != nullptr) {
1947 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1948 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001949 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1950 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1951 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1952 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001953 }
1954 } else {
1955 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001956 skip |= LogError(
1957 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05001958 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1959 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1960 "in VkImageCreateInfo::usage used to create image");
1961 }
1962 }
1963 }
1964 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001965 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1966 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1967 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001968 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001969 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001970 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001971 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001972 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001973 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1974 char const str[] =
1975 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1976 "set.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001977 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001978 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001979 }
1980 return skip;
1981}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001982
John Zulaufeabb4462019-07-05 14:13:03 -06001983void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1984 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1985 const VkImageSubresourceRange *pRanges) {
1986 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1987 auto cb_node = GetCBState(commandBuffer);
1988 auto image_state = GetImageState(image);
1989 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001990 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001991 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001992 }
1993 }
1994}
1995
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001996// Returns true if [x, xoffset] and [y, yoffset] overlap
1997static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1998 bool result = false;
1999 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2000 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2001
2002 if (intersection_max > intersection_min) {
2003 result = true;
2004 }
2005 return result;
2006}
2007
Dave Houltonc991cc92018-03-06 11:08:51 -07002008// Returns true if source area of first copy region intersects dest area of second region
2009// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2010static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002011 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002012
Dave Houltonc991cc92018-03-06 11:08:51 -07002013 // Separate planes within a multiplane image cannot intersect
2014 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002015 return result;
2016 }
2017
Dave Houltonc991cc92018-03-06 11:08:51 -07002018 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2019 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2020 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002021 result = true;
2022 switch (type) {
2023 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002024 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002025 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002026 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002027 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002028 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002029 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002030 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002031 break;
2032 default:
2033 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2034 assert(false);
2035 }
2036 }
2037 return result;
2038}
2039
Dave Houltonfc1a4052017-04-27 14:32:45 -06002040// Returns non-zero if offset and extent exceed image extents
2041static const uint32_t x_bit = 1;
2042static const uint32_t y_bit = 2;
2043static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002044static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002045 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002046 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002047 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2048 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002049 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002050 }
2051 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2052 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002053 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002054 }
2055 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2056 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002057 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002058 }
2059 return result;
2060}
2061
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002062// Test if two VkExtent3D structs are equivalent
2063static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2064 bool result = true;
2065 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2066 (extent->depth != other_extent->depth)) {
2067 result = false;
2068 }
2069 return result;
2070}
2071
Dave Houltonee281a52017-12-08 13:51:02 -07002072// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
2073// Destination image texel extents must be adjusted by block size for the dest validation checks
2074VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
2075 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06002076 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2077 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002078 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002079 adjusted_extent.width /= block_size.width;
2080 adjusted_extent.height /= block_size.height;
2081 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06002082 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2083 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002084 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002085 adjusted_extent.width *= block_size.width;
2086 adjusted_extent.height *= block_size.height;
2087 adjusted_extent.depth *= block_size.depth;
2088 }
2089 return adjusted_extent;
2090}
2091
Dave Houlton6f9059e2017-05-02 17:15:13 -06002092// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002093static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2094 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002095
2096 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002097 if (mip >= img->createInfo.mipLevels) {
2098 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002099 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002100
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002101 // 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 -06002102 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002103
Dave Houltone48cd112019-01-03 17:01:18 -07002104 // If multi-plane, adjust per-plane extent
2105 if (FormatIsMultiplane(img->createInfo.format)) {
2106 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2107 extent.width /= divisors.width;
2108 extent.height /= divisors.height;
2109 }
2110
Jeff Bolzef40fec2018-09-01 22:04:34 -05002111 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2112 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002113 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002114 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2115 } else {
2116 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2117 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2118 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2119 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002120
Dave Houlton6f9059e2017-05-02 17:15:13 -06002121 // Image arrays have an effective z extent that isn't diminished by mip level
2122 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002123 extent.depth = img->createInfo.arrayLayers;
2124 }
2125
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002126 return extent;
2127}
2128
2129// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002130static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002131 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2132}
2133
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002134// Test if the extent argument has any dimensions set to 0.
2135static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2136 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2137}
2138
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002139// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002140VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002141 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2142 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002143 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002144 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002145 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002146 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002147 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002148 granularity.width *= block_size.width;
2149 granularity.height *= block_size.height;
2150 }
2151 }
2152 return granularity;
2153}
2154
2155// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2156static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2157 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002158 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2159 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002160 valid = false;
2161 }
2162 return valid;
2163}
2164
2165// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002166bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002167 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002168 bool skip = false;
2169 VkExtent3D offset_extent = {};
2170 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2171 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2172 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002173 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002174 // 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 -07002175 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002176 skip |= LogError(cb_node->commandBuffer, vuid,
2177 "%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 "
2178 "image transfer granularity is (w=0, h=0, d=0).",
2179 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002180 }
2181 } else {
2182 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2183 // integer multiples of the image transfer granularity.
2184 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002185 skip |= LogError(cb_node->commandBuffer, vuid,
2186 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2187 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2188 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2189 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002190 }
2191 }
2192 return skip;
2193}
2194
2195// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002196bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002197 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002198 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002199 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002200 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002201 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2202 // subresource extent.
2203 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002204 skip |= LogError(cb_node->commandBuffer, vuid,
2205 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2206 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2207 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2208 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002209 }
2210 } else {
2211 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2212 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2213 // subresource extent dimensions.
2214 VkExtent3D offset_extent_sum = {};
2215 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2216 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2217 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002218 bool x_ok = true;
2219 bool y_ok = true;
2220 bool z_ok = true;
2221 switch (image_type) {
2222 case VK_IMAGE_TYPE_3D:
2223 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2224 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002225 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002226 case VK_IMAGE_TYPE_2D:
2227 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2228 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002229 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002230 case VK_IMAGE_TYPE_1D:
2231 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2232 (subresource_extent->width == offset_extent_sum.width));
2233 break;
2234 default:
2235 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2236 assert(false);
2237 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002238 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002239 skip |=
2240 LogError(cb_node->commandBuffer, vuid,
2241 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2242 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2243 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2244 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2245 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2246 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002247 }
2248 }
2249 return skip;
2250}
2251
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002252bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002253 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002254 bool skip = false;
2255 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002256 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2257 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002258 }
2259 return skip;
2260}
2261
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002262bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002263 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002264 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002265 bool skip = false;
2266 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2267 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002268 skip |= LogError(cb_node->commandBuffer, vuid,
2269 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2270 "%u, but provided %s has %u array layers.",
2271 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2272 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002273 }
2274 return skip;
2275}
2276
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002277// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002278bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002279 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002280 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002281 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002282 VkExtent3D granularity = GetScaledItg(cb_node, img);
2283 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002284 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002285 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002286 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002287 return skip;
2288}
2289
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002290// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002291bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002292 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002293 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002294 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002295 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002296 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2297 skip |=
2298 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002299 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002300 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002301 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2302 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002303
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002304 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002305 granularity = GetScaledItg(cb_node, dst_img);
2306 skip |=
2307 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002308 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002309 const VkExtent3D dest_effective_extent =
2310 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002311 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002312 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002313 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002314 return skip;
2315}
2316
Dave Houlton6f9059e2017-05-02 17:15:13 -06002317// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002318bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002319 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002320 bool skip = false;
2321
2322 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002323 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002324
2325 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002326 const VkExtent3D src_copy_extent = region.extent;
2327 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002328 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2329
Dave Houlton6f9059e2017-05-02 17:15:13 -06002330 bool slice_override = false;
2331 uint32_t depth_slices = 0;
2332
2333 // Special case for copying between a 1D/2D array and a 3D image
2334 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2335 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002336 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002337 slice_override = (depth_slices != 1);
2338 } 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 -07002339 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002340 slice_override = (depth_slices != 1);
2341 }
2342
2343 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002344 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002345 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002346 skip |=
2347 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2348 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2349 "be 0 and 1, respectively.",
2350 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002351 }
2352 }
2353
Dave Houlton533be9f2018-03-26 17:08:30 -06002354 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 -07002355 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2356 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2357 "these must be 0 and 1, respectively.",
2358 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002359 }
2360
Dave Houlton533be9f2018-03-26 17:08:30 -06002361 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002362 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2363 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2364 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002365 }
2366
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002367 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002368 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002369 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002370 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002371 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2372 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2373 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2374 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002375 }
2376 }
2377 } else { // Pre maint 1
2378 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002379 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002380 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2381 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2382 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2383 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2384 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002385 }
2386 }
2387 }
2388
Dave Houltonc991cc92018-03-06 11:08:51 -07002389 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002390 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002391 if (FormatIsCompressed(src_state->createInfo.format) ||
2392 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002393 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002394 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002395 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2396 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2397 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002398 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002399 skip |= LogError(src_state->image, vuid,
2400 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2401 "texel width & height (%d, %d).",
2402 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002403 }
2404
Dave Houlton94a00372017-12-14 15:08:47 -07002405 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002406 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2407 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002408 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002409 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002410 LogError(src_state->image, vuid,
2411 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2412 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2413 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002414 }
2415
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002416 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002417 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2418 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002419 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002420 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002421 LogError(src_state->image, vuid,
2422 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2423 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2424 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002425 }
2426
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002427 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002428 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2429 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002430 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002431 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002432 LogError(src_state->image, vuid,
2433 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2434 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2435 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002436 }
2437 } // Compressed
2438
2439 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002440 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002441 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002442 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2443 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2444 "these must be 0 and 1, respectively.",
2445 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002446 }
2447 }
2448
Dave Houlton533be9f2018-03-26 17:08:30 -06002449 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 -07002450 skip |=
2451 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2452 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2453 "and 1, respectively.",
2454 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002455 }
2456
Dave Houlton533be9f2018-03-26 17:08:30 -06002457 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002458 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2459 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2460 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002461 }
2462
2463 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002464 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002465 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2466 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2467 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2468 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002469 }
2470 }
2471 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002472 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002473 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002474 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002475 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002476 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2477 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2478 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2479 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002480 }
2481 }
2482 } else { // Pre maint 1
2483 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002484 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002485 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2486 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2487 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2488 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2489 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002490 }
2491 }
2492 }
2493
Dave Houltonc991cc92018-03-06 11:08:51 -07002494 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2495 if (FormatIsCompressed(dst_state->createInfo.format) ||
2496 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002497 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002498
2499 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002500 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2501 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2502 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002503 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002504 skip |= LogError(dst_state->image, vuid,
2505 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2506 "texel width & height (%d, %d).",
2507 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002508 }
2509
Dave Houlton94a00372017-12-14 15:08:47 -07002510 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002511 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2512 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002513 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002514 skip |= LogError(
2515 dst_state->image, vuid,
2516 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2517 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2518 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002519 }
2520
Dave Houltonee281a52017-12-08 13:51:02 -07002521 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2522 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2523 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002524 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002525 skip |= LogError(dst_state->image, vuid,
2526 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2527 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2528 "height (%d).",
2529 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002530 }
2531
Dave Houltonee281a52017-12-08 13:51:02 -07002532 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2533 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2534 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002535 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002536 skip |= LogError(
2537 dst_state->image, vuid,
2538 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2539 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2540 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002541 }
2542 } // Compressed
2543 }
2544 return skip;
2545}
2546
Dave Houltonc991cc92018-03-06 11:08:51 -07002547// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002548bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002549 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002550 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002551
2552 // Neither image is multiplane
2553 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2554 // If neither image is multi-plane the aspectMask member of src and dst must match
2555 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2556 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002557 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002558 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002559 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002560 }
2561 } else {
2562 // Source image multiplane checks
2563 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2564 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2565 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_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 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002568 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002569 }
2570 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2571 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2572 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002573 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002574 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002575 }
2576 // Single-plane to multi-plane
2577 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2578 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2579 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002580 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002581 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002582 }
2583
2584 // Dest image multiplane checks
2585 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2586 aspect = region.dstSubresource.aspectMask;
2587 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_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 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002590 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002591 }
2592 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2593 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2594 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002595 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002596 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002597 }
2598 // Multi-plane to single-plane
2599 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2600 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2601 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002602 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002603 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002604 }
2605 }
2606
2607 return skip;
2608}
2609
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002610bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2611 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002612 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002613 const auto *cb_node = GetCBState(commandBuffer);
2614 const auto *src_image_state = GetImageState(srcImage);
2615 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002616 const VkFormat src_format = src_image_state->createInfo.format;
2617 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002618 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002619
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002620 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002621
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002622 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2623
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002624 for (uint32_t i = 0; i < regionCount; i++) {
2625 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002626
2627 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2628 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002629 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002630
Dave Houlton6f9059e2017-05-02 17:15:13 -06002631 bool slice_override = false;
2632 uint32_t depth_slices = 0;
2633
2634 // Special case for copying between a 1D/2D array and a 3D image
2635 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2636 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2637 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002638 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002639 slice_override = (depth_slices != 1);
2640 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2641 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002642 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002643 slice_override = (depth_slices != 1);
2644 }
2645
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002646 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2647 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2648 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002649 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002650 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002651 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002652 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002653 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2654 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002655 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002656 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2657 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002658
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002659 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002660 // No chance of mismatch if we're overriding depth slice count
2661 if (!slice_override) {
2662 // The number of depth slices in srcSubresource and dstSubresource must match
2663 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2664 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002665 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2666 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002667 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002668 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2669 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002670 if (src_slices != dst_slices) {
2671 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002672 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002673 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002674 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002675 }
2676 }
2677 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002678 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002679 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002680 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002681 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002682 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002683 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002684 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002685 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002686
Dave Houltonc991cc92018-03-06 11:08:51 -07002687 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002688 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002689 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002690 }
2691
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002692 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002693 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2694 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002695 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002696 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002697 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002698 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002699
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002700 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002701 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002702 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002703 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002704 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002705 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002706 }
2707
2708 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002709 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002710 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002711 ss << "vkCmdCopyImage(): pRegion[" << i
2712 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002713 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002714 }
2715
Dave Houltonfc1a4052017-04-27 14:32:45 -06002716 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002717 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2718 if (slice_override) src_copy_extent.depth = depth_slices;
2719 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002720 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002721 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002722 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2723 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2724 "width [%1d].",
2725 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002726 }
2727
2728 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002729 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002730 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2731 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2732 "height [%1d].",
2733 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002734 }
2735 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002736 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002737 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2738 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2739 "depth [%1d].",
2740 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002741 }
2742
Dave Houltonee281a52017-12-08 13:51:02 -07002743 // Adjust dest extent if necessary
2744 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2745 if (slice_override) dst_copy_extent.depth = depth_slices;
2746
2747 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002748 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002749 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2750 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2751 "width [%1d].",
2752 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002753 }
2754 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002755 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2756 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2757 "height [%1d].",
2758 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002759 }
2760 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002761 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2762 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2763 "depth [%1d].",
2764 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002765 }
2766
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002767 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2768 // must not overlap in memory
2769 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002770 for (uint32_t j = 0; j < regionCount; j++) {
2771 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002772 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002773 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002774 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002775 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002776 }
2777 }
2778 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002779
2780 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2781 if (device_extensions.vk_khr_maintenance1) {
2782 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2783 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2784 (src_copy_extent.depth != 1)) {
2785 skip |= LogError(
2786 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2787 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2788 src_copy_extent.depth);
2789 }
2790 } else {
2791 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2792 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2793 (src_copy_extent.depth != 1)) {
2794 skip |= LogError(
2795 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2796 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2797 src_copy_extent.depth);
2798 }
2799 }
2800
2801 // Check if 2D with 3D and depth not equal to 2D layerCount
2802 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2803 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2804 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2805 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2806 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2807 "srcSubresource.layerCount (%u)",
2808 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2809 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2810 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2811 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2812 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2813 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2814 "dstSubresource.layerCount (%u)",
2815 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2816 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002817
2818 // Check for multi-plane format compatiblity
2819 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
2820 size_t src_format_size = 0;
2821 size_t dst_format_size = 0;
2822 if (FormatIsMultiplane(src_format)) {
2823 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
2824 src_format_size = FormatElementSize(planeFormat);
2825 } else {
2826 src_format_size = FormatElementSize(src_format);
2827 }
2828 if (FormatIsMultiplane(dst_format)) {
2829 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
2830 dst_format_size = FormatElementSize(planeFormat);
2831 } else {
2832 dst_format_size = FormatElementSize(dst_format);
2833 }
2834 // If size is still zero, then format is invalid and will be caught in another VU
2835 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
2836 skip |=
2837 LogError(command_buffer, "VUID-vkCmdCopyImage-None-01549",
2838 "vkCmdCopyImage(): pRegions[%u] called with non-compatible image formats. "
2839 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
2840 i, string_VkFormat(src_format), string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(),
2841 string_VkFormat(dst_format), string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
2842 }
2843 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002844 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002845
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002846 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
2847 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
2848 // because because both texels are 4 bytes in size.
2849 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
2850 const char *compatible_vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2851 : "VUID-vkCmdCopyImage-srcImage-00135";
2852 // Depth/stencil formats must match exactly.
2853 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2854 if (src_format != dst_format) {
2855 skip |= LogError(command_buffer, compatible_vuid,
2856 "vkCmdCopyImage(): Depth/stencil formats must match exactly for src (%s) and dst (%s).",
2857 string_VkFormat(src_format), string_VkFormat(dst_format));
2858 }
2859 } else {
2860 if (!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) {
2861 skip |= LogError(command_buffer, compatible_vuid,
2862 "vkCmdCopyImage(): Unmatched image format sizes. "
2863 "The src format %s has size of %zu and dst format %s has size of %zu.",
2864 string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
2865 FormatElementSize(dst_format));
2866 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002867 }
2868 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002869
Dave Houlton33c22b72017-02-28 13:16:02 -07002870 // Source and dest image sample counts must match
2871 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2872 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002873 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002874 }
2875
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002876 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2877 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002878 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002879 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2880 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2881 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2882 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02002883
2884 // Validation for VK_EXT_fragment_density_map
2885 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2886 skip |= LogError(
2887 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2888 "vkCmdCopyImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2889 }
2890 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2891 skip |= LogError(
2892 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2893 "vkCmdCopyImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2894 }
2895
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002896 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002897 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002898 "VUID-vkCmdCopyImage-srcImage-01995");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002899 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002900 "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002901 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002902 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002903 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002904 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2905 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002906 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002907 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2908 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2909 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2910 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2911 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2912 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002913 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002914 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002915 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2916 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002917 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002918 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2919 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002920 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2921 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002922 }
2923
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002924 return skip;
2925}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002926
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002927void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2928 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2929 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002930 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2931 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002932 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002933 auto src_image_state = GetImageState(srcImage);
2934 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002935
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002936 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002937 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002938 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2939 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002940 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002941}
2942
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002943// Returns true if sub_rect is entirely contained within rect
2944static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2945 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2946 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2947 return false;
2948 return true;
2949}
2950
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002951bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002952 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2953 const VkRect2D &render_area, uint32_t rect_count,
2954 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002955 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002956 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2957 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06002958 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07002959 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002960
2961 for (uint32_t j = 0; j < rect_count; j++) {
2962 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002963 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2964 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2965 "the current render pass instance.",
2966 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002967 }
2968
2969 if (image_view_state) {
2970 // The layers specified by a given element of pRects must be contained within every attachment that
2971 // pAttachments refers to
2972 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2973 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2974 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002975 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2976 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2977 "of pAttachment[%d].",
2978 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002979 }
2980 }
2981 }
2982 return skip;
2983}
2984
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002985bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2986 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002987 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002988 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002989 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002990 if (!cb_node) return skip;
2991
2992 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2993 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2994 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002995 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002996
2997 // Validate that attachment is in reference list of active subpass
2998 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002999 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003000 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003001 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003002 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07003003 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003004
John Zulauf3a548ef2019-02-01 16:14:07 -07003005 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3006 auto clear_desc = &pAttachments[attachment_index];
3007 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003008
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003009 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003010 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003011 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003012 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003013 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003014 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3015 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3016 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3017 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003018 skip |= LogError(
3019 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3020 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3021 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3022 attachment_index, clear_desc->colorAttachment,
3023 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3024 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003025
John Zulauff2582972019-02-09 14:53:30 -07003026 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3027 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003028 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003029 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3030 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3031 " subpass %u. colorAttachmentCount=%u",
3032 attachment_index, clear_desc->colorAttachment,
3033 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3034 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003035 }
John Zulauff2582972019-02-09 14:53:30 -07003036 fb_attachment = color_attachment;
3037
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003038 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3039 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3040 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003041 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003042 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003043 }
3044 } else { // Must be depth and/or stencil
3045 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
3046 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003047 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003048 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003049 }
3050 if (!subpass_desc->pDepthStencilAttachment ||
3051 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003052 skip |= LogPerformanceWarning(
3053 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003054 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003055 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003056 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003057 }
3058 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003059 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003060 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3061 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003062 }
3063 }
3064 }
3065 return skip;
3066}
3067
3068void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3069 const VkClearAttachment *pAttachments, uint32_t rectCount,
3070 const VkClearRect *pRects) {
3071 auto *cb_node = GetCBState(commandBuffer);
3072 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3073 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3074 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3075 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3076 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3077 const auto clear_desc = &pAttachments[attachment_index];
3078 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3079 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3080 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3081 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3082 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3083 subpass_desc->pDepthStencilAttachment) {
3084 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3085 }
3086 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003087 if (!clear_rect_copy) {
3088 // We need a copy of the clear rectangles that will persist until the last lambda executes
3089 // but we want to create it as lazily as possible
3090 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003091 }
John Zulauf441558b2019-08-12 11:47:39 -06003092 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3093 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003094 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003095 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003096 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003097 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003098 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3099 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003100 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3101 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003102 return skip;
3103 };
3104 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003105 }
3106 }
3107 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003108}
3109
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003110bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3111 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003112 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003113 const auto *cb_node = GetCBState(commandBuffer);
3114 const auto *src_image_state = GetImageState(srcImage);
3115 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003116
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003117 bool skip = false;
3118 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003119 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3120 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003121 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003122 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003123 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3124 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003125 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003126 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003127
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003128 // Validation for VK_EXT_fragment_density_map
3129 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3130 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3131 "vkCmdResolveImage(): srcImage must not have been created with flags containing "
3132 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3133 }
3134 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3135 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3136 "vkCmdResolveImage(): dstImage must not have been created with flags containing "
3137 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3138 }
3139
Cort Stratton7df30962018-05-17 19:45:57 -07003140 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003141 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003142 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003143 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3144 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3145 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003146 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003147 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3148 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003149 // For each region, the number of layers in the image subresource should not be zero
3150 // For each region, src and dest image aspect must be color only
3151 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003152 skip |=
3153 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3154 skip |=
3155 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003156 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003157 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3158 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003159 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003160 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3161 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003162 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3163 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3164 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3165 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3166 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003167 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3168 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003169 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003170 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3171 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003172
3173 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003174 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003175 skip |= LogError(
3176 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003177 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003178 }
Cort Stratton7df30962018-05-17 19:45:57 -07003179 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003180 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3181 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3182 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003183 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003184 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003185 }
3186 }
3187
3188 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3189 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003190 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003191 }
3192 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3193 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003194 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003195 }
3196 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3197 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003198 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003199 }
3200 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3201 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003202 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003203 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003204 } else {
3205 assert(0);
3206 }
3207 return skip;
3208}
3209
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003210bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3211 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003212 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003213 const auto *cb_node = GetCBState(commandBuffer);
3214 const auto *src_image_state = GetImageState(srcImage);
3215 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003216
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003217 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003218 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003219 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003220 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003221 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003222 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003223 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003224 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003225 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003226 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3227 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003228 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003229 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3230 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003231 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003232 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3233 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003234 skip |=
3235 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003236 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3237 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003238 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003239 "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003240 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003241 "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003242
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003243 // Validation for VK_EXT_fragment_density_map
3244 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3245 skip |= LogError(
3246 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3247 "vkCmdBlitImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3248 }
3249 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3250 skip |= LogError(
3251 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3252 "vkCmdBlitImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3253 }
3254
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003255 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003256
Dave Houlton33c2d252017-06-09 17:08:32 -06003257 VkFormat src_format = src_image_state->createInfo.format;
3258 VkFormat dst_format = dst_image_state->createInfo.format;
3259 VkImageType src_type = src_image_state->createInfo.imageType;
3260 VkImageType dst_type = dst_image_state->createInfo.imageType;
3261
Cort Stratton186b1a22018-05-01 20:18:06 -04003262 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003263 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003264 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003265 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003266 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003267 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003268 }
3269
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003270 if (FormatRequiresYcbcrConversion(src_format)) {
3271 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3272 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3273 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3274 string_VkFormat(src_format));
3275 }
3276
3277 if (FormatRequiresYcbcrConversion(dst_format)) {
3278 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3279 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3280 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3281 string_VkFormat(dst_format));
3282 }
3283
Dave Houlton33c2d252017-06-09 17:08:32 -06003284 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003285 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3286 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003287 }
3288
Dave Houlton33c2d252017-06-09 17:08:32 -06003289 // Validate consistency for unsigned formats
3290 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3291 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003292 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003293 << "the other one must also have unsigned integer format. "
3294 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003295 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003296 }
3297
3298 // Validate consistency for signed formats
3299 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3300 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003301 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003302 << "the other one must also have signed integer format. "
3303 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003304 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003305 }
3306
3307 // Validate filter for Depth/Stencil formats
3308 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3309 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003310 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003311 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003312 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003313 }
3314
3315 // Validate aspect bits and formats for depth/stencil images
3316 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3317 if (src_format != dst_format) {
3318 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003319 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003320 << "stencil, the other one must have exactly the same format. "
3321 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3322 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003323 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003324 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003325 } // Depth or Stencil
3326
3327 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003328 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003329 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003330 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3331 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3332 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003333 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003334 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3335 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003336 for (uint32_t i = 0; i < regionCount; i++) {
3337 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003338 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003339 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003340 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3341 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003342 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003343 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3344 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003345 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3346 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3347 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003348 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003349 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003350 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003351 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003352 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3353 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003354 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003355 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3356 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003357 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003358 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3359 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003360 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003361 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003362 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003363 }
Dave Houlton48989f32017-05-26 15:01:46 -06003364 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3365 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003366 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003367 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003368 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003369 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003370
3371 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003372 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003373 skip |= LogError(
3374 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003375 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003376 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003377
Dave Houlton48989f32017-05-26 15:01:46 -06003378 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003379 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3380 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003381 }
Dave Houlton48989f32017-05-26 15:01:46 -06003382
Dave Houlton33c2d252017-06-09 17:08:32 -06003383 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003384 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3385 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3386 "image format %s.",
3387 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003388 }
3389
3390 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003391 skip |= LogError(
3392 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003393 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3394 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003395 }
3396
Dave Houlton48989f32017-05-26 15:01:46 -06003397 // Validate source image offsets
3398 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003399 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003400 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003401 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003402 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3403 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3404 "of (%1d, %1d). These must be (0, 1).",
3405 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003406 }
3407 }
3408
Dave Houlton33c2d252017-06-09 17:08:32 -06003409 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003410 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003411 skip |=
3412 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3413 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3414 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3415 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003416 }
3417 }
3418
Dave Houlton33c2d252017-06-09 17:08:32 -06003419 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003420 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3421 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003422 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003423 skip |= LogError(
3424 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003425 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3426 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003427 }
3428 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3429 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003430 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003431 skip |= LogError(
3432 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003433 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003434 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003435 }
3436 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3437 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003438 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003439 skip |= LogError(
3440 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003441 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3442 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003443 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003444 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003445 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3446 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003447 }
Dave Houlton48989f32017-05-26 15:01:46 -06003448
3449 // Validate dest image offsets
3450 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003451 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003452 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003453 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003454 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3455 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3456 "(%1d, %1d). These must be (0, 1).",
3457 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003458 }
3459 }
3460
Dave Houlton33c2d252017-06-09 17:08:32 -06003461 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003462 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003463 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3464 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3465 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3466 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003467 }
3468 }
3469
Dave Houlton33c2d252017-06-09 17:08:32 -06003470 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003471 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3472 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003473 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003474 skip |= LogError(
3475 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003476 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3477 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003478 }
3479 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3480 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003481 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003482 skip |= LogError(
3483 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003484 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003485 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003486 }
3487 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3488 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003489 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003490 skip |= LogError(
3491 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003492 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3493 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003494 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003495 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003496 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3497 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003498 }
3499
Dave Houlton33c2d252017-06-09 17:08:32 -06003500 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3501 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3502 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003503 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003504 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3505 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3506 "layerCount other than 1.",
3507 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003508 }
3509 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003510 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003511 } else {
3512 assert(0);
3513 }
3514 return skip;
3515}
3516
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003517void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3518 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3519 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003520 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3521 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003522 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003523 auto src_image_state = GetImageState(srcImage);
3524 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003525
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003526 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003527 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003528 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3529 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003530 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003531}
3532
John Zulauf2076e812020-01-08 14:55:54 -07003533GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3534 assert(map);
3535 // This approach allows for a single hash lookup or/create new
3536 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3537 if (inserted.second) {
3538 assert(nullptr == inserted.first->second.get());
3539 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.range_encoder.SubresourceCount());
3540 inserted.first->second.reset(layout_map);
3541 return layout_map;
3542 } else {
3543 assert(nullptr != inserted.first->second.get());
3544 return inserted.first->second.get();
3545 }
3546 return nullptr;
3547}
3548
3549const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3550 auto it = map.find(image);
3551 if (it != map.end()) {
3552 return it->second.get();
3553 }
3554 return nullptr;
3555}
3556
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003557// 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 -07003558bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3559 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003560 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003561 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003562 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003563 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003564 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003565 for (const auto &layout_map_entry : pCB->image_layout_map) {
3566 const auto image = layout_map_entry.first;
3567 const auto *image_state = GetImageState(image);
3568 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003569 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003570 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003571 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003572 if (initial_layout_map.empty()) continue;
3573
3574 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3575 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3576 if (global_map == nullptr) {
3577 global_map = &empty_map;
3578 }
3579
3580 // Note: don't know if it would matter
3581 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3582
3583 auto pos = initial_layout_map.begin();
3584 const auto end = initial_layout_map.end();
3585 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3586 pos->first.begin);
3587 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003588 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003589 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003590 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 -07003591 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003592 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003593 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003594 image_layout = current_layout->pos_B->lower_bound->second;
3595 }
3596 const auto intersected_range = pos->first & current_layout->range;
3597 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3598 // TODO: Set memory invalid which is in mem_tracker currently
3599 } else if (image_layout != initial_layout) {
3600 // Need to look up the inital layout *state* to get a bit more information
3601 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3602 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3603 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3604 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07003605 // We can report all the errors for the intersected range directly
3606 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
3607 const auto subresource = image_state->range_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003608 skip |= LogError(
3609 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003610 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003611 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07003612 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003613 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06003614 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003615 }
3616 }
John Zulauf2076e812020-01-08 14:55:54 -07003617 if (pos->first.includes(intersected_range.end)) {
3618 current_layout.seek(intersected_range.end);
3619 } else {
3620 ++pos;
3621 if (pos != end) {
3622 current_layout.seek(pos->first.begin);
3623 }
3624 }
John Zulauff660ad62019-03-23 07:16:05 -06003625 }
3626
locke-lunargf155ccf2020-02-18 11:34:15 -07003627 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003628 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003629 }
John Zulauff660ad62019-03-23 07:16:05 -06003630
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003631 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003632}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003633
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003634void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003635 for (const auto &layout_map_entry : pCB->image_layout_map) {
3636 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003637 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003638 const auto *image_state = GetImageState(image);
3639 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003640 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3641 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003642 }
3643}
3644
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003645// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003646// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3647// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003648bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3649 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003650 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003651 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003652 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3653
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003654 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07003655 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
3656 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003657 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003658 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3659 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3660 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003661 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
3662 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3663 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07003664 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3665 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
3666 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
3667 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3668 string_VkImageLayout(first_layout));
3669 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3670 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003671 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3672 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3673 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003674 }
3675 }
sfricke-samsung55f01952020-03-24 08:16:41 -07003676
3677 // Same as above for loadOp, but for stencilLoadOp
3678 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3679 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3680 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3681 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
3682 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
3683 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3684 string_VkImageLayout(first_layout));
3685 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3686 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
3687 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
3688 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3689 string_VkImageLayout(first_layout));
3690 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3691 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3692 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
3693 "Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003694 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003695 }
3696 }
3697
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003698 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003699}
3700
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003701bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3702 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003703 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003704 const char *vuid;
3705 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003706
Jason Ekstranda1906302017-12-03 20:16:32 -08003707 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3708 VkFormat format = pCreateInfo->pAttachments[i].format;
3709 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3710 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3711 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003712 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
sfricke-samsung6595d272020-05-13 22:43:06 -07003713 "Render pass pAttachment[%u] has loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003714 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3715 "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 -07003716 "render pass.",
3717 i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003718 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003719 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
sfricke-samsung6595d272020-05-13 22:43:06 -07003720 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3721 "Render pass pAttachment[%u] has stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3722 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3723 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3724 "render pass.",
3725 i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003726 }
3727 }
3728 }
3729
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003730 // Track when we're observing the first use of an attachment
3731 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3732 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003733 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003734
3735 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3736 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3737 auto attach_index = subpass.pInputAttachments[j].attachment;
3738 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003739 switch (subpass.pInputAttachments[j].layout) {
3740 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3741 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3742 // These are ideal.
3743 break;
3744
3745 case VK_IMAGE_LAYOUT_GENERAL:
3746 // May not be optimal. TODO: reconsider this warning based on other constraints.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003747 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3748 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
Cort Stratton7547f772017-05-04 15:18:52 -07003749 break;
3750
Tobias Hectorbbb12282018-10-22 15:17:59 +01003751 case VK_IMAGE_LAYOUT_UNDEFINED:
3752 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003753 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003754 skip |= LogError(device, vuid,
3755 "Layout for input attachment reference %u in subpass %u is %s but must be "
3756 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3757 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003758 break;
3759
Piers Daniell9af77cd2019-10-16 13:54:12 -06003760 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3761 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3762 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3763 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003764 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003765 skip |= LogError(
3766 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003767 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3768 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3769 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3770 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3771 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003772 skip |= LogError(
3773 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003774 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3775 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3776 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3777 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3778 } else if ((subpass.pInputAttachments[j].aspectMask &
3779 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3780 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3781 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3782 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3783 const auto *attachment_reference_stencil_layout =
3784 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3785 if (attachment_reference_stencil_layout) {
3786 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3787 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3788 attachment_reference_stencil_layout->stencilLayout ==
3789 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3790 attachment_reference_stencil_layout->stencilLayout ==
3791 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3792 attachment_reference_stencil_layout->stencilLayout ==
3793 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3794 attachment_reference_stencil_layout->stencilLayout ==
3795 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3796 attachment_reference_stencil_layout->stencilLayout ==
3797 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3798 attachment_reference_stencil_layout->stencilLayout ==
3799 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3800 attachment_reference_stencil_layout->stencilLayout ==
3801 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3802 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003803 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3804 "In the attachment reference %u in subpass %u with pNext chain instance "
3805 "VkAttachmentReferenceStencilLayoutKHR"
3806 "the stencilLayout member but must not be "
3807 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3808 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3809 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3810 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3811 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3812 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3813 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3814 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3815 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3816 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003817 }
3818 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003819 skip |= LogError(
3820 device, "VUID-VkAttachmentReference2-attachment-03315",
3821 "When the layout for input attachment reference %u in subpass %u is "
3822 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3823 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3824 "VkAttachmentReferenceStencilLayout instance.",
3825 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003826 }
3827 }
3828 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3829 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3830 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003831 skip |= LogError(
3832 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003833 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3834 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3835 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3836 j, i);
3837 }
3838 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3839 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3840 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003841 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3842 "When the aspectMask for input attachment reference %u in subpass %u is "
3843 "VK_IMAGE_ASPECT_STENCIL_BIT "
3844 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3845 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3846 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003847 }
3848 }
3849 break;
3850
Graeme Leese668a9862018-10-08 10:40:02 +01003851 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3852 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003853 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003854 break;
3855 } else {
3856 // Intentionally fall through to generic error message
3857 }
3858 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003859
Cort Stratton7547f772017-05-04 15:18:52 -07003860 default:
3861 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003862 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3863 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3864 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003865 }
3866
Cort Stratton7547f772017-05-04 15:18:52 -07003867 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003868 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3869 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003870
3871 bool used_as_depth =
3872 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3873 bool used_as_color = false;
3874 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3875 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3876 }
3877 if (!used_as_depth && !used_as_color &&
3878 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003879 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003880 skip |= LogError(device, vuid,
3881 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3882 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003883 }
3884 }
3885 attach_first_use[attach_index] = false;
3886 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003887
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003888 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3889 auto attach_index = subpass.pColorAttachments[j].attachment;
3890 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3891
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003892 // TODO: Need a way to validate shared presentable images here, currently just allowing
3893 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3894 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003895 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003896 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003897 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003898 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3899 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003900 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003901
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003902 case VK_IMAGE_LAYOUT_GENERAL:
3903 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003904 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3905 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003906 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003907
Tobias Hectorbbb12282018-10-22 15:17:59 +01003908 case VK_IMAGE_LAYOUT_UNDEFINED:
3909 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003910 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003911 skip |= LogError(device, vuid,
3912 "Layout for color attachment reference %u in subpass %u is %s but should be "
3913 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3914 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003915 break;
3916
Piers Daniell9af77cd2019-10-16 13:54:12 -06003917 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3918 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3919 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3920 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003921 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003922 skip |= LogError(
3923 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003924 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3925 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3926 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3927 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3928 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003929 skip |= LogError(
3930 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003931 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3932 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3933 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3934 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3935 } else if ((subpass.pColorAttachments[j].aspectMask &
3936 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3937 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3938 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3939 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3940 const auto *attachment_reference_stencil_layout =
3941 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3942 if (attachment_reference_stencil_layout) {
3943 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3944 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3945 attachment_reference_stencil_layout->stencilLayout ==
3946 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3947 attachment_reference_stencil_layout->stencilLayout ==
3948 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3949 attachment_reference_stencil_layout->stencilLayout ==
3950 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3951 attachment_reference_stencil_layout->stencilLayout ==
3952 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3953 attachment_reference_stencil_layout->stencilLayout ==
3954 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3955 attachment_reference_stencil_layout->stencilLayout ==
3956 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3957 attachment_reference_stencil_layout->stencilLayout ==
3958 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3959 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003960 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3961 "In the attachment reference %u in subpass %u with pNext chain instance "
3962 "VkAttachmentReferenceStencilLayoutKHR"
3963 "the stencilLayout member but must not be "
3964 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3965 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3966 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3967 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3968 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3969 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3970 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3971 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3972 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3973 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003974 }
3975 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003976 skip |= LogError(
3977 device, "VUID-VkAttachmentReference2-attachment-03315",
3978 "When the layout for color attachment reference %u in subpass %u is "
3979 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3980 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3981 "VkAttachmentReferenceStencilLayout instance.",
3982 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003983 }
3984 }
3985 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3986 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3987 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003988 skip |= LogError(
3989 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003990 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3991 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3992 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3993 j, i);
3994 }
3995 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3996 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3997 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003998 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3999 "When the aspectMask for color attachment reference %u in subpass %u is "
4000 "VK_IMAGE_ASPECT_STENCIL_BIT "
4001 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4002 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
4003 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004004 }
4005 }
4006 break;
4007
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004008 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004009 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
4010 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
4011 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004012 }
4013
John Zulauf4eee2692019-02-09 16:14:25 -07004014 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
4015 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
4016 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08004017 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004018 skip |= LogError(device, vuid,
4019 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
4020 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
4021 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004022 }
4023
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004024 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004025 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
4026 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004027 }
4028 attach_first_use[attach_index] = false;
4029 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004030
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004031 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
4032 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004033 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
4034 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
4035 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06004036 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06004037
Dave Houltona9df0ce2018-02-07 10:51:23 -07004038 case VK_IMAGE_LAYOUT_GENERAL:
4039 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
4040 // doing a bunch of transitions.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004041 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
4042 "GENERAL layout for depth attachment may not give optimal performance.");
Dave Houltona9df0ce2018-02-07 10:51:23 -07004043 break;
4044
Tobias Hectorbbb12282018-10-22 15:17:59 +01004045 case VK_IMAGE_LAYOUT_UNDEFINED:
4046 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004047 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004048 skip |= LogError(device, vuid,
4049 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
4050 "layout or GENERAL.",
4051 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004052 break;
4053
Piers Daniell9af77cd2019-10-16 13:54:12 -06004054 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4055 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4056 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4057 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004058 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004059 skip |= LogError(
4060 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004061 "Layout for depth attachment reference in subpass %u is %s but must not be "
4062 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4063 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4064 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
4065 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004066 skip |= LogError(
4067 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004068 "Layout for depth attachment reference in subpass %u is %s but must not be "
4069 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4070 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4071 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
4072 } else if ((subpass.pDepthStencilAttachment->aspectMask &
4073 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4074 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4075 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4076 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4077 const auto *attachment_reference_stencil_layout =
4078 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
4079 if (attachment_reference_stencil_layout) {
4080 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4081 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4082 attachment_reference_stencil_layout->stencilLayout ==
4083 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4084 attachment_reference_stencil_layout->stencilLayout ==
4085 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4086 attachment_reference_stencil_layout->stencilLayout ==
4087 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4088 attachment_reference_stencil_layout->stencilLayout ==
4089 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4090 attachment_reference_stencil_layout->stencilLayout ==
4091 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4092 attachment_reference_stencil_layout->stencilLayout ==
4093 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4094 attachment_reference_stencil_layout->stencilLayout ==
4095 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4096 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004097 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
4098 "In the attachment reference in subpass %u with pNext chain instance "
4099 "VkAttachmentReferenceStencilLayoutKHR"
4100 "the stencilLayout member but must not be "
4101 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4102 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4103 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4104 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4105 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4106 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4107 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4108 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4109 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
4110 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004111 }
4112 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004113 skip |= LogError(
4114 device, "VUID-VkAttachmentReference2-attachment-03315",
4115 "When the layout for depth attachment reference in subpass %u is "
4116 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4117 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4118 "VkAttachmentReferenceStencilLayout instance.",
4119 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004120 }
4121 }
4122 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4123 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4124 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004125 skip |= LogError(
4126 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004127 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
4128 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4129 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4130 i);
4131 }
4132 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4133 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4134 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004135 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
4136 "When the aspectMask for depth attachment reference in subpass %u is "
4137 "VK_IMAGE_ASPECT_STENCIL_BIT "
4138 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4139 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
4140 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004141 }
4142 }
4143 break;
4144
Dave Houltona9df0ce2018-02-07 10:51:23 -07004145 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4146 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004147 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004148 break;
4149 } else {
4150 // Intentionally fall through to generic error message
4151 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004152 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004153
Dave Houltona9df0ce2018-02-07 10:51:23 -07004154 default:
4155 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004156 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
4157 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4158 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
4159 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004160 }
4161
4162 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4163 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004164 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4165 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004166 }
4167 attach_first_use[attach_index] = false;
4168 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004169 }
4170 return skip;
4171}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004172
Mark Lobodzinski96210742017-02-09 10:33:46 -07004173// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4174// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004175template <typename T1>
4176bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4177 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4178 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004179 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004180 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004181 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004182 if (strict) {
4183 correct_usage = ((actual & desired) == desired);
4184 } else {
4185 correct_usage = ((actual & desired) != 0);
4186 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004187
Mark Lobodzinski96210742017-02-09 10:33:46 -07004188 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004189 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004190 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004191 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
4192 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4193 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004194 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004195 skip = LogError(object, msgCode,
4196 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4197 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004198 }
4199 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004200 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004201}
4202
4203// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4204// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004205bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004206 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004207 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004208 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004209}
4210
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004211bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004212 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004213 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004214 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4215 if ((image_format_features & desired) != desired) {
4216 // Same error, but more details if it was an AHB external format
4217 if (image_state->has_ahb_format == true) {
4218 skip |= LogError(image_state->image, vuid,
4219 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4220 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4221 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004222 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004223 } else {
4224 skip |= LogError(image_state->image, vuid,
4225 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4226 "with tiling %s.",
4227 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4228 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4229 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004230 }
4231 }
4232 return skip;
4233}
4234
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004235bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004236 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004237 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004238 // layerCount must not be zero
4239 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004240 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4241 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004242 }
4243 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4244 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004245 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4246 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004247 }
4248 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4249 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4250 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004251 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4252 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4253 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4254 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004255 }
4256 return skip;
4257}
4258
Mark Lobodzinski96210742017-02-09 10:33:46 -07004259// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4260// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004261bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004262 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004263 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004264 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004265}
4266
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004267bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004268 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004269 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004270
4271 const VkDeviceSize &range = pCreateInfo->range;
4272 if (range != VK_WHOLE_SIZE) {
4273 // Range must be greater than 0
4274 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004275 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
4276 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4277 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4278 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004279 }
4280 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004281 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4282 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004283 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
4284 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4285 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4286 "(%" PRIu32 ").",
4287 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004288 }
4289 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004290 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004291 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
4292 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4293 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4294 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4295 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004296 }
4297 // The sum of range and offset must be less than or equal to the size of buffer
4298 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004299 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
4300 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4301 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4302 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4303 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004304 }
4305 }
4306 return skip;
4307}
4308
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004309bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004310 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004311 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004312 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4313 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004314 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
4315 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4316 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004317 }
4318 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4319 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004320 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
4321 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4322 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004323 }
4324 return skip;
4325}
4326
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004327bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004328 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004329 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004330
Dave Houltond8ed0212018-05-16 17:18:24 -06004331 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004332
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004333 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004334 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4335 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4336 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004337 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004338
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004339 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004340 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4341 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4342 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004343 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004344
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004345 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004346 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4347 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4348 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004349 }
Jeff Bolz87697532019-01-11 22:54:00 -06004350
4351 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4352 if (chained_devaddr_struct) {
4353 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4354 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004355 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4356 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4357 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004358 }
4359 }
4360
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004361 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4362 if (chained_opaqueaddr_struct) {
4363 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4364 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004365 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4366 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4367 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004368 }
4369 }
4370
Shannon McPherson4984e642019-12-05 13:04:34 -07004371 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004372 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4373 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004374 skip |= LogError(
4375 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004376 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4377 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4378 }
4379
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004380 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004381 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4382 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4383 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004384 }
4385
Mark Lobodzinski96210742017-02-09 10:33:46 -07004386 return skip;
4387}
4388
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004389bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004390 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004391 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004392 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004393 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4394 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004395 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004396 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4397 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004398 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004399 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4400 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4401 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004402
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004403 // Buffer view offset must be less than the size of buffer
4404 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004405 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
4406 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4407 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4408 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004409 }
4410
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004411 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004412 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4413 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4414 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004415 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-02749",
4416 "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) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004551 skip |= LogError(image, errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004552 } else {
4553 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004554
Petr Krausffa94af2017-08-08 21:46:02 +02004555 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004556 skip |= LogError(image, errorCodes.mip_count_err,
4557 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4558 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4559 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4560 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004561 }
Petr Kraus4d718682017-05-18 03:38:41 +02004562 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004563 }
Petr Kraus4d718682017-05-18 03:38:41 +02004564
4565 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004566 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004567 skip |= LogError(image, errorCodes.base_layer_err,
4568 "%s: %s.baseArrayLayer (= %" PRIu32
4569 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4570 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004571 }
Petr Kraus4d718682017-05-18 03:38:41 +02004572
Petr Krausffa94af2017-08-08 21:46:02 +02004573 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4574 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004575 skip |= LogError(image, errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004576 } else {
4577 const uint64_t necessary_layer_count =
4578 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004579
Petr Krausffa94af2017-08-08 21:46:02 +02004580 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004581 skip |= LogError(image, errorCodes.layer_count_err,
4582 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4583 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4584 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4585 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004586 }
Petr Kraus4d718682017-05-18 03:38:41 +02004587 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004588 }
Petr Kraus4d718682017-05-18 03:38:41 +02004589
Mark Lobodzinski602de982017-02-09 11:01:33 -07004590 return skip;
4591}
4592
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004593bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004594 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004595 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004596 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4597 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4598 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4599
4600 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4601 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4602
4603 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004604 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4605 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004606 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004607 : "VUID-VkImageViewCreateInfo-image-01482")
4608 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4609 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004610 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004611 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4612 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004613
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004614 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004615 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004616 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004617}
4618
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004619bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004620 const VkImageSubresourceRange &subresourceRange,
4621 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004622 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004623 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4624 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4625 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4626 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004627
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004628 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004629 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004630 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004631}
4632
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004633bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004634 const VkImageSubresourceRange &subresourceRange,
4635 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004636 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004637 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4638 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4639 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4640 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004641
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004642 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004643 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4644 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004645}
4646
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004647bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004648 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004649 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004650 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004651 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4652 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4653 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4654 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004655
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004656 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004657 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004658}
4659
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004660bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4661 const VkImageUsageFlags image_usage) const {
4662 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4663 bool skip = false;
4664
4665 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4666 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4667
4668 if (image_state->has_ahb_format == true) {
4669 // AHB image view and image share same feature sets
4670 tiling_features = image_state->format_features;
4671 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4672 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4673 assert(device_extensions.vk_ext_image_drm_format_modifier);
4674 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4675 nullptr};
4676 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4677
4678 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4679 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4680 nullptr};
4681 format_properties_2.pNext = (void *)&drm_properties_list;
4682 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4683
4684 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4685 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4686 0) {
4687 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4688 }
4689 }
4690 } else {
4691 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4692 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4693 : format_properties.optimalTilingFeatures;
4694 }
4695
4696 if (tiling_features == 0) {
4697 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4698 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4699 "physical device.",
4700 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4701 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4702 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4703 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4704 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4705 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4706 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4707 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4708 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4709 "VK_IMAGE_USAGE_STORAGE_BIT.",
4710 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4711 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4712 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4713 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4714 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4715 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4716 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4717 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4718 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4719 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4720 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4721 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4722 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4723 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4724 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4725 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4726 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4727 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4728 }
4729
4730 return skip;
4731}
4732
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004733bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004734 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004735 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004736 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004737 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004738 skip |=
4739 ValidateImageUsageFlags(image_state,
4740 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4741 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4742 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4743 false, kVUIDUndefined, "vkCreateImageView()",
4744 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4745 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004746 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004747 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004748 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004749 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004750 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004751 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004752
4753 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4754 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004755 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004756 VkFormat view_format = pCreateInfo->format;
4757 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004758 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004759 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004760
Dave Houltonbd2e2622018-04-10 16:41:14 -06004761 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004762 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004763 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004764 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004765 if (!device_extensions.vk_ext_separate_stencil_usage) {
4766 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004767 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4768 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4769 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004770 }
4771 } else {
4772 const auto image_stencil_struct =
4773 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4774 if (image_stencil_struct == nullptr) {
4775 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004776 skip |= LogError(
4777 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004778 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4779 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4780 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4781 }
4782 } else {
4783 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4784 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4785 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004786 skip |= LogError(
4787 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004788 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4789 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4790 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4791 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4792 }
4793 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4794 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004795 skip |= LogError(
4796 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004797 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4798 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4799 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4800 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4801 }
4802 }
4803 }
4804 }
4805
Dave Houltonbd2e2622018-04-10 16:41:14 -06004806 image_usage = chained_ivuci_struct->usage;
4807 }
4808
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004809 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4810 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004811 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004812 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004813 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004814 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004815 std::stringstream ss;
4816 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004817 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004818 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004819 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004820 }
4821 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004822 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06004823 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4824 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004825 const char *error_vuid;
4826 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4827 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4828 } else if ((device_extensions.vk_khr_maintenance2) &&
4829 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4830 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4831 } else if ((!device_extensions.vk_khr_maintenance2) &&
4832 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4833 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4834 } else {
4835 // both enabled
4836 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4837 }
Dave Houltonc7988072018-04-16 11:46:56 -06004838 std::stringstream ss;
4839 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004840 << " is not in the same format compatibility class as "
4841 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004842 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4843 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004844 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004845 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004846 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004847 }
4848 } else {
4849 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004850 // Unless it is a multi-planar color bit aspect
4851 if ((image_format != view_format) &&
4852 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4853 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4854 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004855 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004856 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004857 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004858 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004859 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004860 }
4861 }
4862
4863 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004864 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004865
4866 switch (image_type) {
4867 case VK_IMAGE_TYPE_1D:
4868 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004869 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4870 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4871 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004872 }
4873 break;
4874 case VK_IMAGE_TYPE_2D:
4875 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4876 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4877 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004878 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4879 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4880 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004881 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004882 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4883 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4884 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004885 }
4886 }
4887 break;
4888 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004889 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004890 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4891 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4892 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004893 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004894 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4895 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4896 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004897 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4898 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004899 skip |= LogError(
4900 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4901 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4902 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4903 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4904 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004905 }
4906 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004907 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4908 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4909 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004910 }
4911 }
4912 } else {
4913 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004914 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4915 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4916 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004917 }
4918 }
4919 break;
4920 default:
4921 break;
4922 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004923
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004924 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004925 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004926 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004927 }
4928
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004929 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004930
Jeff Bolz9af91c52018-09-01 21:53:57 -05004931 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4932 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004933 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4934 "vkCreateImageView() If image was created with usage containing "
4935 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4936 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004937 }
4938 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004939 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4940 "vkCreateImageView() If image was created with usage containing "
4941 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004942 }
4943 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05004944
4945 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
4946 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
4947 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
4948 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
4949 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
4950 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
4951 }
4952 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
4953 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
4954 skip |= LogError(
4955 device, "VUID-VkImageViewCreateInfo-viewType-02963",
4956 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
4957 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
4958 }
4959 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004960
4961 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
4962 if (pCreateInfo->subresourceRange.levelCount != 1) {
4963 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571]]",
4964 "vkCreateImageView(): If image was created with usage containing "
4965 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
4966 pCreateInfo->subresourceRange.levelCount);
4967 }
4968 }
4969 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
4970 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
4971 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572]]",
4972 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
4973 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
4974 }
4975 } else {
4976 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
4977 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
4978 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
4979 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02573",
4980 "vkCreateImageView(): If image was created with usage containing "
4981 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
4982 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
4983 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
4984 }
4985 }
4986 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004987 }
4988 return skip;
4989}
4990
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004991bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4992 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004993 bool skip = false;
4994
4995 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4996 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4997 VkDeviceSize src_min = UINT64_MAX;
4998 VkDeviceSize src_max = 0;
4999 VkDeviceSize dst_min = UINT64_MAX;
5000 VkDeviceSize dst_max = 0;
5001
5002 for (uint32_t i = 0; i < regionCount; i++) {
5003 src_min = std::min(src_min, pRegions[i].srcOffset);
5004 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5005 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5006 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5007
5008 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5009 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005010 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
5011 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
5012 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5013 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005014 }
5015
5016 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5017 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005018 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
5019 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
5020 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5021 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005022 }
5023
5024 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5025 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005026 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
5027 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5028 ") is greater than the source buffer size (%" PRIuLEAST64
5029 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
5030 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005031 }
5032
5033 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5034 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005035 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
5036 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5037 ") is greater than the destination buffer size (%" PRIuLEAST64
5038 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
5039 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005040 }
5041 }
5042
5043 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5044 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5045 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005046 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
5047 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005048 }
5049 }
5050
5051 return skip;
5052}
5053
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005054bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005055 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005056 const auto cb_node = GetCBState(commandBuffer);
5057 const auto src_buffer_state = GetBufferState(srcBuffer);
5058 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005059
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005060 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005061 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5062 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005063 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005064 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005065 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5066 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005067 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005068 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5069 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005070 skip |=
5071 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5072 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005073 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5074 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005075 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005076 return skip;
5077}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005078
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005079bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005080 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005081 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005082 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005083 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
5084 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005085 } else {
5086 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005087 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5088 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005089 }
5090 }
5091 return skip;
5092}
5093
Jeff Bolz5c801d12019-10-09 10:38:45 -05005094bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5095 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005096 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005097 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005098
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005099 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005100 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005101 skip |=
5102 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005103 }
5104 return skip;
5105}
5106
Jeff Bolz5c801d12019-10-09 10:38:45 -05005107bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005108 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005109
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005110 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005111 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005112 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005113 }
5114 return skip;
5115}
5116
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005117bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005118 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005119 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005120 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005121 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005122 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005123 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005124 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005125 }
5126 return skip;
5127}
5128
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005129bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005130 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005131 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005132 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005133 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005134 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005135 skip |=
5136 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5137 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005138 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005139 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005140 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5141 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005142 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005143
5144 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005145 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5146 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5147 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5148 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005149 }
5150
5151 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005152 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5153 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5154 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5155 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005156 }
5157
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005158 return skip;
5159}
5160
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005161bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
5162 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005163 bool skip = false;
5164
5165 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005166 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5167 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005168 skip |=
5169 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
5170 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5171 "and 1, respectively.",
5172 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005173 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005174 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005175
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005176 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5177 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005178 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
5179 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
5180 "must be 0 and 1, respectively.",
5181 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005182 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005183 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005184
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005185 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5186 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005187 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
5188 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5189 "For 3D images these must be 0 and 1, respectively.",
5190 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005191 }
5192 }
5193
5194 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005195 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07005196 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
5197
Dave Houltona585d132019-01-18 13:05:42 -07005198 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005199 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00193",
5200 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5201 " must be a multiple of this format's texel size (%" PRIu32 ").",
5202 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005203 }
5204
5205 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06005206 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005207 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00194",
5208 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
5209 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005210 }
5211
5212 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5213 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005214 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005215 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
5216 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5217 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005218 }
5219
5220 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5221 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005222 skip |= LogError(
5223 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005224 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5225 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005226 }
5227
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005228 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005229 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005230 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005231 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 -06005232 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5233 static_cast<int32_t>(adjusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005234 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
5235 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5236 "zero or <= image subresource width (%d).",
5237 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005238 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005239 }
5240
5241 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005242 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 -06005243 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5244 static_cast<int32_t>(adjusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005245 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
5246 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5247 "zero or <= image subresource height (%d).",
5248 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005249 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005250 }
5251
5252 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005253 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 -06005254 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5255 static_cast<int32_t>(adjusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005256 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
5257 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5258 "zero or <= image subresource depth (%d).",
5259 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005260 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005261 }
5262
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005263 // subresource aspectMask must have exactly 1 bit set
5264 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
5265 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
5266 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005267 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
5268 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005269 }
5270
5271 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06005272 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005273 skip |= LogError(
5274 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005275 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5276 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005277 }
5278
5279 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04005280 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005281 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005282
5283 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005284 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005285 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5286 ? "VUID-VkBufferImageCopy-None-01735"
5287 : "VUID-VkBufferImageCopy-bufferRowLength-00203";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005288 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005289 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005290 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5291 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005292 }
5293
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005294 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005295 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005296 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5297 ? "VUID-VkBufferImageCopy-None-01736"
5298 : "VUID-VkBufferImageCopy-bufferImageHeight-00204";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005299 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005300 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005301 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5302 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005303 }
5304
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005305 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005306 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5307 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5308 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005309 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01737"
5310 : "VUID-VkBufferImageCopy-imageOffset-00205";
5311 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005312 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5313 "width & height (%d, %d)..",
5314 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5315 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005316 }
5317
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005318 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07005319 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005320 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005321 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5322 ? "VUID-VkBufferImageCopy-None-01738"
5323 : "VUID-VkBufferImageCopy-bufferOffset-00206";
5324 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005325 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5326 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5327 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005328 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005329
5330 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005331 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005332 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005333 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005334 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01739"
5335 : "VUID-VkBufferImageCopy-imageExtent-00207";
5336 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005337 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5338 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5339 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5340 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005341 }
5342
5343 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005344 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005345 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005346 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01740"
5347 : "VUID-VkBufferImageCopy-imageExtent-00208";
5348 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005349 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5350 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5351 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5352 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005353 }
5354
5355 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005356 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005357 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005358 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01741"
5359 : "VUID-VkBufferImageCopy-imageExtent-00209";
5360 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005361 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5362 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5363 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5364 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005365 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005366 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005367
5368 // Checks that apply only to multi-planar format images
5369 if (FormatIsMultiplane(image_state->createInfo.format)) {
5370 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5371 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5372 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005373 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5374 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5375 "format has three planes.",
5376 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005377 }
5378
5379 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5380 if (0 == (pRegions[i].imageSubresource.aspectMask &
5381 (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 -07005382 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5383 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5384 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5385 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005386 }
5387 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005388 }
5389
5390 return skip;
5391}
5392
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005393bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5394 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005395 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005396 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005397
5398 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005399 VkExtent3D extent = pRegions[i].imageExtent;
5400 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005401
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005402 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5403 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005404 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5405 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5406 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005407 }
5408
5409 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5410
5411 // 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 -06005412 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005413 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005414 if (image_extent.width % block_extent.width) {
5415 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5416 }
5417 if (image_extent.height % block_extent.height) {
5418 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5419 }
5420 if (image_extent.depth % block_extent.depth) {
5421 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5422 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005423 }
5424
Dave Houltonfc1a4052017-04-27 14:32:45 -06005425 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005426 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005427 }
5428 }
5429
5430 return skip;
5431}
5432
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005433bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5434 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005435 bool skip = false;
5436
5437 VkDeviceSize buffer_size = buff_state->createInfo.size;
5438
5439 for (uint32_t i = 0; i < regionCount; i++) {
5440 VkExtent3D copy_extent = pRegions[i].imageExtent;
5441
5442 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5443 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005444 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5445 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005446
Tom Cooperb2550c72018-10-15 13:08:41 +01005447 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005448 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005449 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005450 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5451 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5452
5453 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5454 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5455 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005456 }
5457
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005458 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5459 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5460 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005461 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005462 } else {
5463 // Calculate buffer offset of final copied byte, + 1.
5464 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5465 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5466 max_buffer_offset *= unit_size; // convert to bytes
5467 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005468
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005469 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005470 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5471 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005472 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005473 }
5474 }
5475
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005476 return skip;
5477}
5478
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005479bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005480 VkBuffer dstBuffer, uint32_t regionCount,
5481 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005482 const auto cb_node = GetCBState(commandBuffer);
5483 const auto src_image_state = GetImageState(srcImage);
5484 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005485
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005486 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005487
5488 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005489 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005490
5491 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005492 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005493
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005494 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005495
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005496 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005497 skip |=
5498 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5499 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5500 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005501 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005502 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005503 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005504 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005505 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005506
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005507 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005508 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005509 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5510 skip |=
5511 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005512
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005513 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005514 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005515 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5516 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005517 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005518 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5519 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005520
5521 // Validation for VK_EXT_fragment_density_map
5522 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5523 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyImageToBuffer-srcImage-02544",
5524 "vkCmdCopyBufferToImage(): srcImage must not have been created with flags containing "
5525 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5526 }
5527
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005528 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005529 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005530 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005531 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005532 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005533 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005534 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5535 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5536 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005537 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005538 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005539 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005540 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005541 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5542 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005543 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5544 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5545 skip |=
5546 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5547 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5548 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005549 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5550 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005551 }
5552 return skip;
5553}
5554
John Zulauf1686f232019-07-09 16:27:11 -06005555void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5556 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5557 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5558
5559 auto cb_node = GetCBState(commandBuffer);
5560 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005561 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005562 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005563 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005564 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005565}
5566
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005567bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5568 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005569 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005570 const auto cb_node = GetCBState(commandBuffer);
5571 const auto src_buffer_state = GetBufferState(srcBuffer);
5572 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005573
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005574 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005575
5576 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005577 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005578
5579 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005580 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005581 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005582 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005583 skip |=
5584 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5585 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5586 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005587 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005588 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005589 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005590 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005591 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005592 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005593 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005594 skip |=
5595 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5596 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005597 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005598 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5599 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005600 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005601 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5602 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005603
5604 // Validation for VK_EXT_fragment_density_map
5605 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5606 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyBufferToImage-dstImage-02543",
5607 "vkCmdCopyBufferToImage(): dstImage must not have been created with flags containing "
5608 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5609 }
5610
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005611 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005612 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005613 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005614 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005615 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005616 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005617 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5618 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5619 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005620 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005621 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005622 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005623 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005624 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5625 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005626 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5627 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5628 skip |=
5629 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5630 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5631 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005632 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5633 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005634 }
5635 return skip;
5636}
5637
John Zulauf1686f232019-07-09 16:27:11 -06005638void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5639 VkImageLayout dstImageLayout, uint32_t regionCount,
5640 const VkBufferImageCopy *pRegions) {
5641 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5642
5643 auto cb_node = GetCBState(commandBuffer);
5644 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005645 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005646 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005647 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005648 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005649}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005650
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005651bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005652 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005653 bool skip = false;
5654 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5655
Dave Houlton1d960ff2018-01-19 12:17:05 -07005656 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005657 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5658 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5659 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005660 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5661 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005662 }
5663
John Zulaufa26d3c82019-08-14 16:09:08 -06005664 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005665 if (!image_entry) {
5666 return skip;
5667 }
5668
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005669 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5670 if (device_extensions.vk_ext_image_drm_format_modifier) {
5671 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5672 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005673 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5674 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5675 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005676 }
5677 } else {
5678 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005679 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5680 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005681 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005682 }
5683
Dave Houlton1d960ff2018-01-19 12:17:05 -07005684 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005685 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005686 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5687 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5688 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005689 }
5690
Dave Houlton1d960ff2018-01-19 12:17:05 -07005691 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005692 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005693 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5694 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5695 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005696 }
5697
Dave Houlton1d960ff2018-01-19 12:17:05 -07005698 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005699 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005700 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5701 if (FormatIsMultiplane(img_format)) {
5702 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5703 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5704 if (FormatPlaneCount(img_format) > 2u) {
5705 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5706 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5707 }
5708 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005709 skip |= LogError(image, vuid,
5710 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5711 ") must be a single-plane specifier flag.",
5712 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005713 }
5714 } else if (FormatIsColor(img_format)) {
5715 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005716 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5717 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5718 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005719 }
5720 } else if (FormatIsDepthOrStencil(img_format)) {
5721 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5722 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005723 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005724 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5725 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5726 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5727 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005728 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5729 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5730 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005731 }
5732 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005733
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005734 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005735 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005736 }
5737
Mike Weiblen672b58b2017-02-21 14:32:53 -07005738 return skip;
5739}