blob: f0dcde3812f5cac0ec5bf5681d5e25958d699d5f [file] [log] [blame]
sfricke-samsung552d5e12020-01-07 22:00:20 -08001/* Copyright (c) 2015-2020 The Khronos Group Inc.
2 * Copyright (c) 2015-2020 Valve Corporation
3 * Copyright (c) 2015-2020 LunarG, Inc.
4 * Copyright (C) 2015-2020 Google Inc.
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07005 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060019 * Author: Dave Houlton <daveh@lunarg.com>
Shannon McPherson3ea65132018-12-05 10:37:39 -070020 * Shannon McPherson <shannon@lunarg.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070021 */
22
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060023#include <cmath>
24#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070025#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020026#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027
28#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020029#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030#include "vk_layer_data.h"
31#include "vk_layer_utils.h"
32#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060033#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070034
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070035#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070036#include "core_validation.h"
37#include "shader_validation.h"
38#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070039#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070040
John Zulauff660ad62019-03-23 07:16:05 -060041// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
42static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
43 VkImageSubresourceRange subresource_range;
44 subresource_range.aspectMask = subresource_layers.aspectMask;
45 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
46 subresource_range.layerCount = subresource_layers.layerCount;
47 subresource_range.baseMipLevel = subresource_layers.mipLevel;
48 subresource_range.levelCount = 1;
49 return subresource_range;
50}
51
John Zulaufb58415b2019-12-09 15:02:32 -070052static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
53 const VkImageSubresourceRange &range);
54static VkImageSubresourceRange MakeImageFullRange(const VkImageCreateInfo &create_info) {
55 const auto format = create_info.format;
56 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
57 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
58 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
59 } else {
60 init_range.aspectMask =
61 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
62 }
63 return NormalizeSubresourceRange(create_info, init_range);
64}
65
John Zulauff660ad62019-03-23 07:16:05 -060066IMAGE_STATE::IMAGE_STATE(VkImage img, const VkImageCreateInfo *pCreateInfo)
67 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -070068 safe_create_info(pCreateInfo),
69 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -060070 valid(false),
71 acquired(false),
72 shared_presentable(false),
73 layout_locked(false),
74 get_sparse_reqs_called(false),
75 sparse_metadata_required(false),
76 sparse_metadata_bound(false),
John Zulauff660ad62019-03-23 07:16:05 -060077 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -070078 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -060079 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -070080 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -060081 create_from_swapchain(VK_NULL_HANDLE),
82 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -060083 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -070084 range_encoder(full_range),
sfricke-samsung71bc6572020-04-29 15:49:43 -070085 disjoint(false),
86 plane0_memory_requirements_checked(false),
87 plane1_memory_requirements_checked(false),
88 plane2_memory_requirements_checked(false),
unknown08c57af2019-06-21 16:33:35 -060089 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060090 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
91 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
92 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
93 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
94 }
95 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
96 }
97
98 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
99 sparse = true;
100 }
Locked8af3732019-05-10 09:47:56 -0600101
sfricke-samsunge2441192019-11-06 14:07:57 -0800102 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
103 if (externalMemoryInfo) {
104 external_memory_handle = externalMemoryInfo->handleTypes;
105 }
John Zulauff660ad62019-03-23 07:16:05 -0600106}
107
unknown2c877272019-07-11 12:56:50 -0600108bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
109 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
110 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
111 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
112 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
113 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
114 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600115 return is_equal &&
116 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600117}
118
Jeff Bolz82f854d2019-09-17 14:56:47 -0500119// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
120bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
121 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
122 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
123 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
124 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
125 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600126 is_compatible = is_compatible &&
127 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
128 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500129
130 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
131 createInfo.extent.height <= other_createInfo.extent.height &&
132 createInfo.extent.depth <= other_createInfo.extent.depth &&
133 createInfo.arrayLayers <= other_createInfo.arrayLayers;
134 return is_compatible;
135}
136
unknown2c877272019-07-11 12:56:50 -0600137bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700138 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
139 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
140 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700141 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
142 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600143 IsCreateInfoEqual(other_image_state->createInfo)) {
144 return true;
145 }
unknowne1661522019-07-11 13:04:18 -0600146 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
147 return true;
148 }
unknown2c877272019-07-11 12:56:50 -0600149 return false;
150}
151
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500152IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
153 : image_view(iv),
154 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700155 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
156 range_generator(im->range_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500157 samplerConversion(VK_NULL_HANDLE),
158 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600159 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
160 if (conversionInfo) samplerConversion = conversionInfo->conversion;
161 if (image_state) {
162 // A light normalization of the createInfo range
163 auto &sub_res_range = create_info.subresourceRange;
164 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
165 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
166
167 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700168 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500169 samples = image_state->createInfo.samples;
170 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600171 }
172}
173
Dave Houltond9611312018-11-19 17:03:36 -0700174uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
175 // uint cast applies floor()
176 return 1u + (uint32_t)log2(std::max({height, width, depth}));
177}
178
179uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
180
181uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
182
John Zulaufb58415b2019-12-09 15:02:32 -0700183static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
184 const VkImageSubresourceRange &range) {
John Zulauff660ad62019-03-23 07:16:05 -0600185 VkImageSubresourceRange norm = range;
186 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
187
188 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
189 // <arrayLayers> can potentially alias.
190 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
191 ? image_create_info.extent.depth
192 : image_create_info.arrayLayers;
193 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
194
195 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
196 VkImageAspectFlags &aspect_mask = norm.aspectMask;
197 if (FormatIsMultiplane(image_create_info.format)) {
198 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
199 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
200 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
201 if (FormatPlaneCount(image_create_info.format) > 2) {
202 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
203 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700204 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700205 }
John Zulauff660ad62019-03-23 07:16:05 -0600206 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700207}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700208
John Zulaufb58415b2019-12-09 15:02:32 -0700209VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
210 const VkImageCreateInfo &image_create_info = image_state.createInfo;
211 return NormalizeSubresourceRange(image_create_info, range);
212}
213
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500214bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700215 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700216 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700217
John Zulauf2076e812020-01-08 14:55:54 -0700218 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
219 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700220 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
221 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
222
John Zulauf2076e812020-01-08 14:55:54 -0700223 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
224
225 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
226 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700227 return false;
228 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700229
John Zulauf2076e812020-01-08 14:55:54 -0700230 for (auto entry : *layout_range_map) {
231 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700232 }
233 return true;
234}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700235
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600236// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600237void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600238 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
239 VkImageLayout expected_layout) {
240 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
241 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600242 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600243 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700244 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700245 for (const auto &image : image_state.aliasing_images) {
246 auto alias_state = GetImageState(image);
247 // The map state of the aliases should all be in sync, so no need to check the return value
248 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
249 assert(subresource_map);
250 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
251 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700252}
John Zulauff660ad62019-03-23 07:16:05 -0600253
254// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600255void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600256 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500257 return;
258 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500259 IMAGE_STATE *image_state = view_state.image_state.get();
260 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700261 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700262 for (const auto &image : image_state->aliasing_images) {
263 image_state = GetImageState(image);
264 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
265 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
266 }
John Zulauff660ad62019-03-23 07:16:05 -0600267}
268
269// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600270void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600271 const VkImageSubresourceRange &range, VkImageLayout layout) {
272 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
273 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600274 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700275 for (const auto &image : image_state.aliasing_images) {
276 auto alias_state = GetImageState(image);
277 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
278 assert(subresource_map);
279 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
280 }
John Zulauff660ad62019-03-23 07:16:05 -0600281}
282
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600283void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600284 VkImageLayout layout) {
285 const IMAGE_STATE *image_state = GetImageState(image);
286 if (!image_state) return;
287 SetImageInitialLayout(cb_node, *image_state, range, layout);
288};
289
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600290void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600291 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
292 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600293}
Dave Houltonddd65c52018-05-08 14:58:01 -0600294
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600295// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700296void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
297 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500298 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600299
John Zulauff660ad62019-03-23 07:16:05 -0600300 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600301 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
302 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600303 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state.create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
Dave Houltonddd65c52018-05-08 14:58:01 -0600304 sub_range.baseArrayLayer = 0;
305 sub_range.layerCount = image_state->createInfo.extent.depth;
306 }
307
Piers Daniell4fde9b72019-11-27 16:19:46 -0700308 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
309 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
310 SetImageLayout(cb_node, *image_state, sub_range, layout);
311 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
312 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
313 } else {
314 SetImageLayout(cb_node, *image_state, sub_range, layout);
315 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600316}
317
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700318bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
319 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700320 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600321 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100322 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700323 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100324 const char *vuid;
325 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700326 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100327
328 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600329 LogObjectList objlist(image);
330 objlist.add(renderpass);
331 objlist.add(framebuffer);
332 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700333 skip |=
334 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
335 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
336 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
337 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100338 return skip;
339 }
340
341 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200342 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
343 if (stencil_usage_info) {
344 image_usage |= stencil_usage_info->stencilUsage;
345 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100346
347 // Check for layouts that mismatch image usages in the framebuffer
348 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800349 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600350 LogObjectList objlist(image);
351 objlist.add(renderpass);
352 objlist.add(framebuffer);
353 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700354 skip |= LogError(objlist, vuid,
355 "%s: Layout/usage mismatch for attachment %u in %s"
356 " - the %s is %s but the image attached to %s via %s"
357 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
358 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
359 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
360 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100361 }
362
363 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
364 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800365 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600366 LogObjectList objlist(image);
367 objlist.add(renderpass);
368 objlist.add(framebuffer);
369 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700370 skip |= LogError(objlist, vuid,
371 "%s: Layout/usage mismatch for attachment %u in %s"
372 " - the %s is %s but the image attached to %s via %s"
373 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
374 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
375 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
376 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100377 }
378
379 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800380 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600381 LogObjectList objlist(image);
382 objlist.add(renderpass);
383 objlist.add(framebuffer);
384 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700385 skip |= LogError(objlist, vuid,
386 "%s: Layout/usage mismatch for attachment %u in %s"
387 " - the %s is %s but the image attached to %s via %s"
388 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
389 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
390 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
391 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100392 }
393
394 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800395 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600396 LogObjectList objlist(image);
397 objlist.add(renderpass);
398 objlist.add(framebuffer);
399 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700400 skip |= LogError(objlist, vuid,
401 "%s: Layout/usage mismatch for attachment %u in %s"
402 " - the %s is %s but the image attached to %s via %s"
403 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
404 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
405 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
406 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100407 }
408
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600409 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100410 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
411 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
412 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
413 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
414 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800415 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600416 LogObjectList objlist(image);
417 objlist.add(renderpass);
418 objlist.add(framebuffer);
419 objlist.add(image_view);
420 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700421 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700422 " - the %s is %s but the image attached to %s via %s"
423 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700424 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700425 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
426 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100427 }
428 } else {
429 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
430 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
431 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
432 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600433 LogObjectList objlist(image);
434 objlist.add(renderpass);
435 objlist.add(framebuffer);
436 objlist.add(image_view);
437 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700438 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700439 " - the %s is %s but the image attached to %s via %s"
440 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700441 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700442 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
443 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100444 }
445 }
446 return skip;
447}
448
John Zulauf17a01bb2019-08-09 16:41:19 -0600449bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700450 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600451 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600452 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700453 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700454 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100455 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100456
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700457 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100458 auto framebuffer = framebuffer_state->framebuffer;
459
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700460 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700461 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
462 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700463 }
John Zulauf8e308292018-09-21 11:34:37 -0600464
Tobias Hectorc9057422019-07-23 12:15:52 +0100465 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
466 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
467 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100468 }
469
Tobias Hectorc9057422019-07-23 12:15:52 +0100470 if (attachments != nullptr) {
471 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
472 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
473 auto image_view = attachments[i];
474 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100475
Tobias Hectorc9057422019-07-23 12:15:52 +0100476 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600477 LogObjectList objlist(pRenderPassBegin->renderPass);
478 objlist.add(framebuffer_state->framebuffer);
479 objlist.add(image_view);
480 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700481 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
482 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
483 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100484 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100485 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100486
487 const VkImage image = view_state->create_info.image;
488 const IMAGE_STATE *image_state = GetImageState(image);
489
490 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600491 LogObjectList objlist(pRenderPassBegin->renderPass);
492 objlist.add(framebuffer_state->framebuffer);
493 objlist.add(image_view);
494 objlist.add(image);
495 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700496 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
497 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
498 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100499 continue;
500 }
501 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
502 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
503
Piers Daniell7f894f62020-01-09 16:33:48 -0700504 // Default to expecting stencil in the same layout.
505 auto attachment_stencil_initial_layout = attachment_initial_layout;
506
507 // If a separate layout is specified, look for that.
508 const auto *attachment_description_stencil_layout =
509 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
510 if (attachment_description_stencil_layout) {
511 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
512 }
513
Tobias Hectorc9057422019-07-23 12:15:52 +0100514 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
515 // in common with the non-const version.)
516 const ImageSubresourceLayoutMap *subresource_map =
517 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
518
519 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
520 LayoutUseCheckAndMessage layout_check(subresource_map);
521 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700522 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
523 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
524 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700525
John Zulauf5e617452019-11-19 14:44:16 -0700526 // Allow for differing depth and stencil layouts
527 VkImageLayout check_layout = attachment_initial_layout;
528 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
529
530 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700531 subres_skip |= LogError(
532 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700533 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
534 "and the %s layout of the attachment is %s. The layouts must match, or the render "
535 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700536 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100537 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700538 }
John Zulauf5e617452019-11-19 14:44:16 -0700539
Tobias Hectorc9057422019-07-23 12:15:52 +0100540 skip |= subres_skip;
541 }
542
543 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
544 framebuffer, render_pass, i, "initial layout");
545
546 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
547 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100548 }
549
Tobias Hectorc9057422019-07-23 12:15:52 +0100550 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
551 auto &subpass = pRenderPassInfo->pSubpasses[j];
552 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
553 auto &attachment_ref = subpass.pInputAttachments[k];
554 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
555 auto image_view = attachments[attachment_ref.attachment];
556 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100557
Tobias Hectorc9057422019-07-23 12:15:52 +0100558 if (view_state) {
559 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700560 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
561 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100562 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100563 }
564 }
565 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100566
Tobias Hectorc9057422019-07-23 12:15:52 +0100567 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
568 auto &attachment_ref = subpass.pColorAttachments[k];
569 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
570 auto image_view = attachments[attachment_ref.attachment];
571 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100572
Tobias Hectorc9057422019-07-23 12:15:52 +0100573 if (view_state) {
574 auto image = view_state->create_info.image;
575 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
576 framebuffer, render_pass, attachment_ref.attachment,
577 "color attachment layout");
578 if (subpass.pResolveAttachments) {
579 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
580 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
581 attachment_ref.attachment, "resolve attachment layout");
582 }
583 }
584 }
585 }
586
587 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
588 auto &attachment_ref = *subpass.pDepthStencilAttachment;
589 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
590 auto image_view = attachments[attachment_ref.attachment];
591 auto view_state = GetImageViewState(image_view);
592
593 if (view_state) {
594 auto image = view_state->create_info.image;
595 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
596 framebuffer, render_pass, attachment_ref.attachment,
597 "input attachment layout");
598 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100599 }
600 }
601 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700602 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600603 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700604}
605
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600606void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700607 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700608 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700609 IMAGE_VIEW_STATE *image_view = nullptr;
610 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
611 const auto attachment_info =
612 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
613 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
614 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300615 image_view = GetAttachmentImageViewState(pCB, pFramebuffer, ref.attachment);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700616 }
John Zulauf8e308292018-09-21 11:34:37 -0600617 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700618 VkImageLayout stencil_layout = kInvalidLayout;
619 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
620 if (attachment_reference_stencil_layout) {
621 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
622 }
623
624 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600625 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700626 }
627}
628
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600629void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
630 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700631 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700632
633 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700634 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700635 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700636 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700637 }
638 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700639 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700640 }
641 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700642 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700643 }
644 }
645}
646
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700647// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
648// 1. Transition into initialLayout state
649// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600650void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700651 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700652 // First transition into initialLayout
653 auto const rpci = render_pass_state->createInfo.ptr();
654 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700655 IMAGE_VIEW_STATE *view_state = nullptr;
656 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
657 const auto attachment_info =
658 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
659 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
660 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300661 view_state = GetAttachmentImageViewState(cb_state, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700662 }
John Zulauf8e308292018-09-21 11:34:37 -0600663 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700664 VkImageLayout stencil_layout = kInvalidLayout;
665 const auto *attachment_description_stencil_layout =
666 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
667 if (attachment_description_stencil_layout) {
668 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
669 }
670
671 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600672 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700673 }
674 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700675 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700676}
677
Dave Houlton10b39482017-03-16 13:18:15 -0600678bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600679 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600680 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600681 }
682 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600683 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600684 }
685 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600686 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600687 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700688 if (0 !=
689 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
690 if (FormatPlaneCount(format) == 1) return false;
691 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600692 return true;
693}
694
Mike Weiblen62d08a32017-03-07 22:18:27 -0700695// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200696bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
697 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600698 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700699 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200700 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600701 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700702
703 switch (layout) {
704 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
705 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600706 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700707 }
708 break;
709 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
710 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600711 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700712 }
713 break;
714 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
715 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600716 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700717 }
718 break;
719 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
720 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600721 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700722 }
723 break;
724 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
725 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600726 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700727 }
728 break;
729 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
730 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600731 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700732 }
733 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600734 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500735 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
736 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
737 }
738 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700739 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
740 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
741 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
742 }
743 break;
744 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
745 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
746 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
747 }
748 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700749 default:
750 // Other VkImageLayout values do not have VUs defined in this context.
751 break;
752 }
753
Dave Houlton8e9f6542018-05-18 12:18:22 -0600754 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700755 skip |= LogError(img_barrier.image, msg_code,
756 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
757 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
758 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700759 }
760 return skip;
761}
762
763// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600764bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
765 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700766 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700767
Petr Krausad0096a2019-08-09 18:35:04 +0200768 // Scoreboard for checking for duplicate and inconsistent barriers to images
769 struct ImageBarrierScoreboardEntry {
770 uint32_t index;
771 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
772 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
773 const VkImageMemoryBarrier *barrier;
774 };
775 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
776 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
777
John Zulauf463c51e2018-05-31 13:29:20 -0600778 // Scoreboard for duplicate layout transition barriers within the list
779 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
780 ImageBarrierScoreboardImageMap layout_transitions;
781
Mike Weiblen62d08a32017-03-07 22:18:27 -0700782 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200783 const auto &img_barrier = pImageMemoryBarriers[i];
784 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700785
John Zulauf463c51e2018-05-31 13:29:20 -0600786 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
787 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
788 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200789 if (img_barrier.oldLayout != img_barrier.newLayout) {
790 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
791 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600792 if (image_it != layout_transitions.end()) {
793 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200794 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600795 if (subres_it != subres_map.end()) {
796 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200797 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
798 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
799 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700800 skip = LogError(
801 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200802 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600803 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
804 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200805 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
806 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
807 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600808 }
809 entry = new_entry;
810 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200811 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600812 }
813 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200814 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600815 }
816 }
817
Petr Krausad0096a2019-08-09 18:35:04 +0200818 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600819 if (image_state) {
820 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200821 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
822 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600823
824 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
825 if (image_state->layout_locked) {
826 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700827 skip |= LogError(
828 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700829 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600830 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700831 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200832 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600833 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600834
John Zulaufa4472282019-08-22 14:44:34 -0600835 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700836 const VkFormat image_format = image_create_info.format;
837 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600838 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700839 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700840 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600841 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
842 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700843 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
844 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
845 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
846 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700847 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600848 }
849 } else {
850 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
851 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -0700852 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
853 ? "VUID-VkImageMemoryBarrier-image-03320"
854 : "VUID-VkImageMemoryBarrier-image-01207";
855 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700856 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
857 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
858 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700859 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600860 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700861 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700862 }
John Zulauff660ad62019-03-23 07:16:05 -0600863
Petr Krausad0096a2019-08-09 18:35:04 +0200864 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
865 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600866 // TODO: Set memory invalid which is in mem_tracker currently
867 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
868 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600869 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600870 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600871 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200872 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700873 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
874 const auto &value = *pos;
875 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700876 subres_skip = LogError(
877 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700878 "%s: For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
John Zulauf5e617452019-11-19 14:44:16 -0700879 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700880 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -0700881 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
882 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600883 }
John Zulauf5e617452019-11-19 14:44:16 -0700884 }
John Zulauff660ad62019-03-23 07:16:05 -0600885 skip |= subres_skip;
886 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700887
888 // checks color format and (single-plane or non-disjoint)
889 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
890 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700891 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700892 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
893 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
894 ? "VUID-VkImageMemoryBarrier-image-01671"
895 : "VUID-VkImageMemoryBarrier-image-02902";
896 skip |= LogError(img_barrier.image, vuid,
897 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
898 "but its aspectMask is 0x%" PRIx32 ".",
899 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
900 string_VkFormat(image_format), aspect_mask);
901 }
902 }
903
904 VkImageAspectFlags valid_disjoint_mask =
905 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 -0700906 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700907 ((aspect_mask & valid_disjoint_mask) == 0)) {
908 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
909 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
910 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
911 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
912 string_VkFormat(image_format), aspect_mask);
913 }
914
915 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
916 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
917 "%s: Image barrier %s references %s of format %s has only two planes but included "
918 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
919 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
920 string_VkFormat(image_format), aspect_mask);
921 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700922 }
923 }
924 return skip;
925}
926
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600927bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200928 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700929
Jeff Bolz6835fda2019-10-06 00:15:34 -0500930 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200931 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700932}
933
John Zulauf6b4aae82018-05-09 13:03:36 -0600934template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600935bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
936 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600937 using BarrierRecord = QFOTransferBarrier<Barrier>;
938 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500939 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600940 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
941 const char *barrier_name = BarrierRecord::BarrierName();
942 const char *handle_name = BarrierRecord::HandleName();
943 const char *transfer_type = nullptr;
944 for (uint32_t b = 0; b < barrier_count; b++) {
945 if (!IsTransferOp(&barriers[b])) continue;
946 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700947 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600948 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600949 const auto found = barrier_sets.release.find(barriers[b]);
950 if (found != barrier_sets.release.cend()) {
951 barrier_record = &(*found);
952 transfer_type = "releasing";
953 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600954 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600955 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600956 const auto found = barrier_sets.acquire.find(barriers[b]);
957 if (found != barrier_sets.acquire.cend()) {
958 barrier_record = &(*found);
959 transfer_type = "acquiring";
960 }
961 }
962 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700963 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
964 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
965 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
966 func_name, barrier_name, b, transfer_type, handle_name,
967 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
968 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600969 }
970 }
971 return skip;
972}
973
John Zulaufa4472282019-08-22 14:44:34 -0600974VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
975 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
976}
977
978const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
979 return device_state.GetImageState(barrier.image);
980}
981
982VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
983 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
984}
985
986const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
987 return device_state.GetBufferState(barrier.buffer);
988}
989
990VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
991
John Zulauf6b4aae82018-05-09 13:03:36 -0600992template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600993void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
994 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500995 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600996 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
997 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600998 auto &barrier = barriers[b];
999 if (IsTransferOp(&barrier)) {
1000 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001001 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001002 barrier_sets.release.emplace(barrier);
1003 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001004 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001005 barrier_sets.acquire.emplace(barrier);
1006 }
1007 }
1008
1009 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1010 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1011 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1012 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1013 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1014 auto handle_state = BarrierHandleState(*this, barrier);
1015 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1016 if (!mode_concurrent) {
1017 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001018 cb_state->queue_submit_functions.emplace_back(
1019 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1020 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1021 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1022 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001023 });
1024 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001025 }
1026 }
1027}
1028
John Zulaufa4472282019-08-22 14:44:34 -06001029bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001030 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001031 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001032 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001033 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001034 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1035 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001036 return skip;
1037}
1038
John Zulaufa4472282019-08-22 14:44:34 -06001039void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1040 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1041 const VkImageMemoryBarrier *pImageMemBarriers) {
1042 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1043 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001044}
1045
1046template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001047bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001048 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001049 // Record to the scoreboard or report that we have a duplication
1050 bool skip = false;
1051 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1052 if (!inserted.second && inserted.first->second != cb_state) {
1053 // 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 -06001054 LogObjectList objlist(cb_state->commandBuffer);
1055 objlist.add(barrier.handle);
1056 objlist.add(inserted.first->second->commandBuffer);
1057 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001058 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1059 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1060 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1061 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1062 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001063 }
1064 return skip;
1065}
1066
1067template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001068bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1069 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001070 using BarrierRecord = QFOTransferBarrier<Barrier>;
1071 using TypeTag = typename BarrierRecord::Tag;
1072 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001073 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001074 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001075 const char *barrier_name = BarrierRecord::BarrierName();
1076 const char *handle_name = BarrierRecord::HandleName();
1077 // No release should have an extant duplicate (WARNING)
1078 for (const auto &release : cb_barriers.release) {
1079 // Check the global pending release barriers
1080 const auto set_it = global_release_barriers.find(release.handle);
1081 if (set_it != global_release_barriers.cend()) {
1082 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1083 const auto found = set_for_handle.find(release);
1084 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001085 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1086 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1087 " to dstQueueFamilyIndex %" PRIu32
1088 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1089 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1090 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001091 }
1092 }
1093 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1094 }
1095 // Each acquire must have a matching release (ERROR)
1096 for (const auto &acquire : cb_barriers.acquire) {
1097 const auto set_it = global_release_barriers.find(acquire.handle);
1098 bool matching_release_found = false;
1099 if (set_it != global_release_barriers.cend()) {
1100 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1101 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1102 }
1103 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001104 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1105 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1106 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1107 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1108 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001109 }
1110 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1111 }
1112 return skip;
1113}
1114
John Zulauf3b04ebd2019-07-18 14:08:11 -06001115bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001116 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001117 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001118 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001119 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1120 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001121 return skip;
1122}
1123
1124template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001125void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001126 using BarrierRecord = QFOTransferBarrier<Barrier>;
1127 using TypeTag = typename BarrierRecord::Tag;
1128 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001129 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001130
1131 // Add release barriers from this submit to the global map
1132 for (const auto &release : cb_barriers.release) {
1133 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1134 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1135 global_release_barriers[release.handle].insert(release);
1136 }
1137
1138 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1139 for (const auto &acquire : cb_barriers.acquire) {
1140 // NOTE: We're not using [] because we don't want to create entries for missing releases
1141 auto set_it = global_release_barriers.find(acquire.handle);
1142 if (set_it != global_release_barriers.end()) {
1143 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1144 set_for_handle.erase(acquire);
1145 if (set_for_handle.size() == 0) { // Clean up empty sets
1146 global_release_barriers.erase(set_it);
1147 }
1148 }
1149 }
1150}
1151
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001152void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001153 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1154 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001155}
1156
John Zulauf6b4aae82018-05-09 13:03:36 -06001157// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001158void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001159
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001160void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001161 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001162 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001163 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001164
Chris Forbes4de4b132017-08-21 11:27:08 -07001165 // For ownership transfers, the barrier is specified twice; as a release
1166 // operation on the yielding queue family, and as an acquire operation
1167 // on the acquiring queue family. This barrier may also include a layout
1168 // transition, which occurs 'between' the two operations. For validation
1169 // purposes it doesn't seem important which side performs the layout
1170 // transition, but it must not be performed twice. We'll arbitrarily
1171 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001172 //
1173 // However, we still need to record initial layout for the "initial layout" validation
1174 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001175
Petr Krausad0096a2019-08-09 18:35:04 +02001176 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001177 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001178 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001179 }
1180}
1181
unknown86bcb3a2019-07-11 13:05:36 -06001182void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001183 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001184 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1185 const auto &image_create_info = image_state->createInfo;
1186
1187 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1188 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1189 // for all (potential) layer sub_resources.
1190 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1191 normalized_isr.baseArrayLayer = 0;
1192 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1193 }
1194
Michael Spang8af7c102020-05-03 20:50:09 -04001195 VkImageLayout initial_layout = mem_barrier.oldLayout;
1196
1197 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001198 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001199 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1200 }
1201
John Zulauf2be3fe02019-12-30 09:48:02 -07001202 if (is_release_op) {
1203 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1204 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001205 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001206 }
unknown86bcb3a2019-07-11 13:05:36 -06001207}
1208
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001209bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1210 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1211 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1212 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001213 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001214 assert(cb_node);
1215 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001216 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001217 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001218
John Zulauff660ad62019-03-23 07:16:05 -06001219 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1220 if (subresource_map) {
1221 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001222 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001223 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1224 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001225 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001226 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1227 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1228 "%s layout %s.",
1229 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1230 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1231 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001232 }
John Zulauf5e617452019-11-19 14:44:16 -07001233 }
John Zulauff660ad62019-03-23 07:16:05 -06001234 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001235 }
John Zulauff660ad62019-03-23 07:16:05 -06001236
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001237 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1238 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1239 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001240 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1241 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001242 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1243 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1244 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001245 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001246 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001247 if (image_state->shared_presentable) {
1248 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001249 skip |=
1250 LogError(device, layout_invalid_msg_code,
1251 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1252 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001253 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001254 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001255 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001256 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001257 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1258 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1259 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1260 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001261 }
1262 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001263 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001264}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001265bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001266 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1267 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001268 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001269 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1270 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1271}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001272
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001273void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001274 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001275 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001276 if (!renderPass) return;
1277
Tobias Hectorbbb12282018-10-22 15:17:59 +01001278 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001279 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001280 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001281 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001282 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1283 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1284 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1285 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001286 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001287 }
John Zulauf8e308292018-09-21 11:34:37 -06001288 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001289 VkImageLayout stencil_layout = kInvalidLayout;
1290 const auto *attachment_description_stencil_layout =
1291 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1292 if (attachment_description_stencil_layout) {
1293 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1294 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001295 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001296 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001297 }
1298 }
1299}
Dave Houltone19e20d2018-02-02 16:32:41 -07001300
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001301#ifdef VK_USE_PLATFORM_ANDROID_KHR
1302// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1303// This could also move into a seperate core_validation_android.cpp file... ?
1304
1305//
1306// AHB-specific validation within non-AHB APIs
1307//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001308bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001309 bool skip = false;
1310
1311 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1312 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001313 if (0 != ext_fmt_android->externalFormat) {
1314 if (VK_FORMAT_UNDEFINED != create_info->format) {
1315 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001316 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1317 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1318 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001319 }
1320
1321 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001322 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1323 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1324 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001325 }
1326
1327 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001328 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1329 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001330 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1331 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1332 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001333 }
1334
1335 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001336 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1337 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1338 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001339 }
1340 }
1341
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001342 if ((0 != ext_fmt_android->externalFormat) &&
1343 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001344 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001345 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1346 ") which has "
1347 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1348 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001349 }
1350 }
1351
Dave Houltond9611312018-11-19 17:03:36 -07001352 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001353 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001354 skip |=
1355 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1356 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1357 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001358 }
1359 }
1360
1361 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1362 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1363 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001364 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001365 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1366 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1367 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1368 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001369 }
1370
1371 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001372 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1373 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1374 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1375 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1376 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001377 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001378 }
1379
1380 return skip;
1381}
1382
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001383bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001384 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001385 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001386
1387 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001388 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001389 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1390 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001391 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001392 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001393 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001394
Dave Houltond9611312018-11-19 17:03:36 -07001395 // Chain must include a compatible ycbcr conversion
1396 bool conv_found = false;
1397 uint64_t external_format = 0;
1398 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1399 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001400 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001401 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001402 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001403 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001404 }
Dave Houltond9611312018-11-19 17:03:36 -07001405 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001406 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001407 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001408 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1409 "an externalFormat (%" PRIu64
1410 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1411 "with the same external format.",
1412 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001413 }
1414
1415 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001416 if (IsIdentitySwizzle(create_info->components) == false) {
1417 skip |= LogError(
1418 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, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1421 "= %s.",
1422 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1423 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001424 }
1425 }
Dave Houltond9611312018-11-19 17:03:36 -07001426
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001427 return skip;
1428}
1429
John Zulaufa26d3c82019-08-14 16:09:08 -06001430bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001431 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001432
John Zulaufa26d3c82019-08-14 16:09:08 -06001433 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001434 if (image_state != nullptr) {
1435 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1436 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1437 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1438 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1439 "bound to memory.");
1440 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001441 }
1442 return skip;
1443}
1444
1445#else
1446
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001447bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001448 return false;
1449}
1450
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001451bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001452
John Zulaufa26d3c82019-08-14 16:09:08 -06001453bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001454
1455#endif // VK_USE_PLATFORM_ANDROID_KHR
1456
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001457bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1458 bool skip = false;
1459
1460 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1461 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1462 const VkImageTiling image_tiling = pCreateInfo->tiling;
1463 const VkFormat image_format = pCreateInfo->format;
1464
1465 if (image_format == VK_FORMAT_UNDEFINED) {
1466 // VU 01975 states format can't be undefined unless an android externalFormat
1467#ifdef VK_USE_PLATFORM_ANDROID_KHR
1468 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1469 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1470 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1471 if (it != ahb_ext_formats_map.end()) {
1472 tiling_features = it->second;
1473 }
1474 }
1475#endif
1476 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1477 uint64_t drm_format_modifier = 0;
1478 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1479 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1480 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1481 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1482
1483 if (drm_explicit != nullptr) {
1484 drm_format_modifier = drm_explicit->drmFormatModifier;
1485 } else {
1486 // VUID 02261 makes sure its only explict or implict in parameter checking
1487 assert(drm_implicit != nullptr);
1488 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1489 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1490 }
1491 }
1492
1493 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1494 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1495 nullptr};
1496 format_properties_2.pNext = (void *)&drm_properties_list;
1497 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001498 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1499 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1500 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1501 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001502
1503 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1504 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1505 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1506 }
1507 }
1508 } else {
1509 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1510 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1511 : format_properties.optimalTilingFeatures;
1512 }
1513
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001514 // Lack of disjoint format feature support while using the flag
1515 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1516 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1517 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1518 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1519 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1520 string_VkFormat(pCreateInfo->format));
1521 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001522
1523 return skip;
1524}
1525
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001526bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001527 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001528 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001529
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001530 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001531 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001532 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1533 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001534 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1535 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001536 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001537 }
1538
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001539 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1540 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001541 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1542 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1543 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001544 }
1545
1546 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001547 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1548 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1549 "height (%d) and arrayLayers (%d) must be >= 6.",
1550 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001551 }
Dave Houlton130c0212018-01-29 13:39:56 -07001552 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001553
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001554 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001555 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1556 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1557 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001558 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1559 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1560 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001561 }
1562
1563 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001564 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1565 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1566 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001567 }
1568
ByumjinConffx991b6062019-08-14 15:17:53 -07001569 if (device_extensions.vk_ext_fragment_density_map) {
1570 uint32_t ceiling_width =
1571 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1572 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1573 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1574 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001575 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1576 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1577 "ceiling of device "
1578 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1579 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1580 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001581 }
1582
1583 uint32_t ceiling_height =
1584 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1585 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1586 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1587 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001588 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1589 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1590 "ceiling of device "
1591 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1592 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1593 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001594 }
1595 }
1596
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001597 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001598 VkResult result = VK_SUCCESS;
1599 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1600 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1601 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1602 &format_limits);
1603 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001604 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1605 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1606 if (modifier_list) {
1607 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1608 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1609 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1610 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1611 image_format_info.type = pCreateInfo->imageType;
1612 image_format_info.format = pCreateInfo->format;
1613 image_format_info.tiling = pCreateInfo->tiling;
1614 image_format_info.usage = pCreateInfo->usage;
1615 image_format_info.flags = pCreateInfo->flags;
1616 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1617
1618 result =
1619 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1620 format_limits = image_format_properties.imageFormatProperties;
1621
1622 /* The application gives a list of modifier and the driver
1623 * selects one. If one is wrong, stop there.
1624 */
1625 if (result != VK_SUCCESS) break;
1626 }
1627 } else if (explicit_modifier) {
1628 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1629 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1630 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1631 image_format_info.type = pCreateInfo->imageType;
1632 image_format_info.format = pCreateInfo->format;
1633 image_format_info.tiling = pCreateInfo->tiling;
1634 image_format_info.usage = pCreateInfo->usage;
1635 image_format_info.flags = pCreateInfo->flags;
1636 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1637
1638 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1639 format_limits = image_format_properties.imageFormatProperties;
1640 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001641 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001642
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001643 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001644#ifdef VK_USE_PLATFORM_ANDROID_KHR
1645 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1646#endif // VK_USE_PLATFORM_ANDROID_KHR
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001647 skip |= LogError(device, kVUID_Core_Image_FormatNotSupported,
1648 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
1649 "VkGetPhysicalDeviceImageFormatProperties returned back VK_ERROR_FORMAT_NOT_SUPPORTED.",
1650 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001651 } else {
1652 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1653 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001654 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1655 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1656 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001657 }
Dave Houlton130c0212018-01-29 13:39:56 -07001658
Dave Houltona585d132019-01-18 13:05:42 -07001659 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1660 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1661 (uint64_t)pCreateInfo->samples;
1662 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001663
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001664 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001665 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001666 uint64_t ig_mask = imageGranularity - 1;
1667 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001668
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001669 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001670 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1671 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1672 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1673 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001674 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001675
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001676 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001677 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1678 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1679 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001680 }
1681
1682 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001683 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1684 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1685 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001686 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001687 }
1688
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001689 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001690 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1691 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1692 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1693 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001694 skip |= LogError(device, error_vuid,
1695 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1696 "YCbCr Conversion format, arrayLayers must be 1",
1697 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001698 }
1699
1700 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001701 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1702 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1703 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001704 }
1705
1706 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001707 skip |= LogError(
1708 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001709 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1710 string_VkSampleCountFlagBits(pCreateInfo->samples));
1711 }
1712
1713 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001714 skip |= LogError(
1715 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001716 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1717 string_VkImageType(pCreateInfo->imageType));
1718 }
1719 }
1720
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001721 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001722 skip |=
1723 LogError(device, "VUID-VkImageCreateInfo-flags-01924",
1724 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1725 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001726 }
1727
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001728 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001729 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001730 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1731 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001732 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1733 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1734 "format must be block, ETC or ASTC compressed, but is %s",
1735 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001736 }
1737 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001738 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1739 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1740 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001741 }
1742 }
1743 }
1744
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001745 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001746 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1747 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1748 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001749 }
1750
unknown2c877272019-07-11 12:56:50 -06001751 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1752 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1753 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001754 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1755 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1756 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001757 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001758
1759 skip |= ValidateImageFormatFeatures(pCreateInfo);
1760
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001761 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001762}
1763
John Zulauf7eeb6f72019-06-17 11:56:36 -06001764void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1765 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1766 if (VK_SUCCESS != result) return;
1767
1768 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001769 auto image_state = Get<IMAGE_STATE>(*pImage);
1770 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001771}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001772
Jeff Bolz5c801d12019-10-09 10:38:45 -05001773bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001774 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001775 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001776 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001777 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001778 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001779 }
1780 return skip;
1781}
1782
John Zulauf7eeb6f72019-06-17 11:56:36 -06001783void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1784 // Clean up validation specific data
1785 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001786
locke-lunargcba7d5f2019-12-30 16:59:11 -07001787 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001788
1789 // Clean up generic image state
1790 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001791}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001792
sfricke-samsungcd924d92020-05-20 23:51:17 -07001793bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
1794 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001795 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07001796 const VkImage image = image_state->image;
1797 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001798
1799 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001800 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
1801 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001802 }
1803
sfricke-samsungcd924d92020-05-20 23:51:17 -07001804 if (FormatIsDepthOrStencil(format)) {
1805 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1806 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
1807 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
1808 } else if (FormatIsCompressed(format)) {
1809 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1810 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
1811 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001812 }
1813
1814 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001815 skip |=
1816 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
1817 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
1818 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001819 }
1820 return skip;
1821}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001822
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001823uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1824 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1825 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001826 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001827 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001828 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001829 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001830}
1831
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001832uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1833 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1834 uint32_t array_layer_count = range->layerCount;
1835 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1836 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001837 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001838 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001839}
1840
John Zulauf07288512019-07-05 11:09:50 -06001841bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1842 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1843 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001844 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001845 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1846 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001847 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1848 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1849 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001850 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001851
1852 } else {
1853 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1854 if (!device_extensions.vk_khr_shared_presentable_image) {
1855 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001856 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1857 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1858 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001859 }
1860 } else {
1861 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1862 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001863 skip |= LogError(
1864 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001865 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1866 func_name, string_VkImageLayout(dest_image_layout));
1867 }
1868 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001869 }
1870
John Zulauff660ad62019-03-23 07:16:05 -06001871 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001872 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001873 if (subresource_map) {
1874 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001875 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001876 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001877 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1878 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001879 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1880 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1881 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1882 } else {
1883 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001884 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001885 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1886 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1887 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1888 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001889 }
John Zulauf5e617452019-11-19 14:44:16 -07001890 }
John Zulauff660ad62019-03-23 07:16:05 -06001891 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001892 }
1893
1894 return skip;
1895}
1896
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001897bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1898 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001899 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001900 bool skip = false;
1901 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001902 const auto *cb_node = GetCBState(commandBuffer);
1903 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001904 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001905 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001906 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001907 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001908 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001909 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001910 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1911 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001912 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001913 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001914 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001915 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001916 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07001917 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001918 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001919 }
sfricke-samsunge775d492020-02-28 09:02:25 -08001920 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
1921 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
1922 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
1923 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
1924 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
1925 string_VkFormat(image_state->createInfo.format));
1926 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001927 }
1928 return skip;
1929}
1930
John Zulaufeabb4462019-07-05 14:13:03 -06001931void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1932 const VkClearColorValue *pColor, uint32_t rangeCount,
1933 const VkImageSubresourceRange *pRanges) {
1934 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1935
1936 auto cb_node = GetCBState(commandBuffer);
1937 auto image_state = GetImageState(image);
1938 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001939 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001940 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001941 }
1942 }
1943}
1944
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001945bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1946 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001947 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001948 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001949
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001950 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001951 const auto *cb_node = GetCBState(commandBuffer);
1952 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001953 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001954 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001955 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001956 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001957 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001958 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001959 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001960 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001961 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001962 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001963 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001964
1965 bool any_include_aspect_depth_bit = false;
1966 bool any_include_aspect_stencil_bit = false;
1967
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001968 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001969 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001970 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001971 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001972 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001973 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1974 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001975 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
1976 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
1977 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
1978 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001979 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001980 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1981 any_include_aspect_depth_bit = true;
1982 }
1983 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1984 any_include_aspect_stencil_bit = true;
1985 }
1986 }
1987 if (any_include_aspect_stencil_bit) {
1988 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1989 if (image_stencil_struct != nullptr) {
1990 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1991 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001992 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1993 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1994 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1995 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001996 }
1997 } else {
1998 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001999 skip |= LogError(
2000 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002001 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2002 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2003 "in VkImageCreateInfo::usage used to create image");
2004 }
2005 }
2006 }
2007 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002008 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2009 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2010 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002011 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06002012 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002013 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2014 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
2015 report_data->FormatHandle(image).c_str(), string_VkFormat(image_state->createInfo.format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002016 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002017 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002018 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2019 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2020 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2021 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002022 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002023 }
2024 return skip;
2025}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002026
John Zulaufeabb4462019-07-05 14:13:03 -06002027void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2028 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2029 const VkImageSubresourceRange *pRanges) {
2030 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2031 auto cb_node = GetCBState(commandBuffer);
2032 auto image_state = GetImageState(image);
2033 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002034 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002035 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002036 }
2037 }
2038}
2039
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002040// Returns true if [x, xoffset] and [y, yoffset] overlap
2041static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2042 bool result = false;
2043 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2044 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2045
2046 if (intersection_max > intersection_min) {
2047 result = true;
2048 }
2049 return result;
2050}
2051
Dave Houltonc991cc92018-03-06 11:08:51 -07002052// Returns true if source area of first copy region intersects dest area of second region
2053// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2054static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002055 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002056
Dave Houltonc991cc92018-03-06 11:08:51 -07002057 // Separate planes within a multiplane image cannot intersect
2058 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002059 return result;
2060 }
2061
Dave Houltonc991cc92018-03-06 11:08:51 -07002062 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2063 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2064 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002065 result = true;
2066 switch (type) {
2067 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002068 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002069 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002070 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002071 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002072 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002073 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002074 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002075 break;
2076 default:
2077 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2078 assert(false);
2079 }
2080 }
2081 return result;
2082}
2083
Dave Houltonfc1a4052017-04-27 14:32:45 -06002084// Returns non-zero if offset and extent exceed image extents
2085static const uint32_t x_bit = 1;
2086static const uint32_t y_bit = 2;
2087static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002088static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002089 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002090 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002091 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2092 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002093 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002094 }
2095 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2096 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002097 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002098 }
2099 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2100 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002101 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002102 }
2103 return result;
2104}
2105
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002106// Test if two VkExtent3D structs are equivalent
2107static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2108 bool result = true;
2109 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2110 (extent->depth != other_extent->depth)) {
2111 result = false;
2112 }
2113 return result;
2114}
2115
Dave Houltonee281a52017-12-08 13:51:02 -07002116// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
2117// Destination image texel extents must be adjusted by block size for the dest validation checks
2118VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
2119 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06002120 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2121 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002122 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002123 adjusted_extent.width /= block_size.width;
2124 adjusted_extent.height /= block_size.height;
2125 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06002126 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2127 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002128 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002129 adjusted_extent.width *= block_size.width;
2130 adjusted_extent.height *= block_size.height;
2131 adjusted_extent.depth *= block_size.depth;
2132 }
2133 return adjusted_extent;
2134}
2135
Dave Houlton6f9059e2017-05-02 17:15:13 -06002136// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002137static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2138 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002139
2140 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002141 if (mip >= img->createInfo.mipLevels) {
2142 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002143 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002144
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002145 // 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 -06002146 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002147
Dave Houltone48cd112019-01-03 17:01:18 -07002148 // If multi-plane, adjust per-plane extent
2149 if (FormatIsMultiplane(img->createInfo.format)) {
2150 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2151 extent.width /= divisors.width;
2152 extent.height /= divisors.height;
2153 }
2154
Jeff Bolzef40fec2018-09-01 22:04:34 -05002155 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2156 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002157 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002158 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2159 } else {
2160 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2161 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2162 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2163 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002164
Dave Houlton6f9059e2017-05-02 17:15:13 -06002165 // Image arrays have an effective z extent that isn't diminished by mip level
2166 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002167 extent.depth = img->createInfo.arrayLayers;
2168 }
2169
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002170 return extent;
2171}
2172
2173// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002174static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002175 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2176}
2177
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002178// Test if the extent argument has any dimensions set to 0.
2179static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2180 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2181}
2182
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002183// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002184VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002185 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2186 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002187 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002188 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002189 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002190 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002191 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002192 granularity.width *= block_size.width;
2193 granularity.height *= block_size.height;
2194 }
2195 }
2196 return granularity;
2197}
2198
2199// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2200static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2201 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002202 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2203 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002204 valid = false;
2205 }
2206 return valid;
2207}
2208
2209// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002210bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002211 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002212 bool skip = false;
2213 VkExtent3D offset_extent = {};
2214 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2215 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2216 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002217 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002218 // 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 -07002219 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002220 skip |= LogError(cb_node->commandBuffer, vuid,
2221 "%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 "
2222 "image transfer granularity is (w=0, h=0, d=0).",
2223 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002224 }
2225 } else {
2226 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2227 // integer multiples of the image transfer granularity.
2228 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002229 skip |= LogError(cb_node->commandBuffer, vuid,
2230 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2231 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2232 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2233 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002234 }
2235 }
2236 return skip;
2237}
2238
2239// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002240bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002241 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002242 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002243 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002244 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002245 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2246 // subresource extent.
2247 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002248 skip |= LogError(cb_node->commandBuffer, vuid,
2249 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2250 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2251 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2252 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002253 }
2254 } else {
2255 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2256 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2257 // subresource extent dimensions.
2258 VkExtent3D offset_extent_sum = {};
2259 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2260 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2261 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002262 bool x_ok = true;
2263 bool y_ok = true;
2264 bool z_ok = true;
2265 switch (image_type) {
2266 case VK_IMAGE_TYPE_3D:
2267 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2268 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002269 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002270 case VK_IMAGE_TYPE_2D:
2271 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2272 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002273 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002274 case VK_IMAGE_TYPE_1D:
2275 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2276 (subresource_extent->width == offset_extent_sum.width));
2277 break;
2278 default:
2279 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2280 assert(false);
2281 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002282 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002283 skip |=
2284 LogError(cb_node->commandBuffer, vuid,
2285 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2286 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2287 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2288 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2289 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2290 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002291 }
2292 }
2293 return skip;
2294}
2295
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002296bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002297 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002298 bool skip = false;
2299 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002300 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2301 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002302 }
2303 return skip;
2304}
2305
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002306bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002307 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002308 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002309 bool skip = false;
2310 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2311 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002312 skip |= LogError(cb_node->commandBuffer, vuid,
2313 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2314 "%u, but provided %s has %u array layers.",
2315 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2316 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002317 }
2318 return skip;
2319}
2320
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002321// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002322bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002323 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002324 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002325 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002326 VkExtent3D granularity = GetScaledItg(cb_node, img);
2327 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002328 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002329 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002330 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002331 return skip;
2332}
2333
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002334// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002335bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002336 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002337 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002338 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002339 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002340 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2341 skip |=
2342 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002343 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002344 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002345 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2346 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002347
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002348 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002349 granularity = GetScaledItg(cb_node, dst_img);
2350 skip |=
2351 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002352 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002353 const VkExtent3D dest_effective_extent =
2354 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002355 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002356 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002357 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002358 return skip;
2359}
2360
Dave Houlton6f9059e2017-05-02 17:15:13 -06002361// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002362bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002363 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002364 bool skip = false;
2365
2366 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002367 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002368
2369 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002370 const VkExtent3D src_copy_extent = region.extent;
2371 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002372 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2373
Dave Houlton6f9059e2017-05-02 17:15:13 -06002374 bool slice_override = false;
2375 uint32_t depth_slices = 0;
2376
2377 // Special case for copying between a 1D/2D array and a 3D image
2378 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2379 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002380 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002381 slice_override = (depth_slices != 1);
2382 } 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 -07002383 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002384 slice_override = (depth_slices != 1);
2385 }
2386
2387 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002388 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002389 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002390 skip |=
2391 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2392 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2393 "be 0 and 1, respectively.",
2394 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002395 }
2396 }
2397
Dave Houlton533be9f2018-03-26 17:08:30 -06002398 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 -07002399 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2400 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2401 "these must be 0 and 1, respectively.",
2402 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002403 }
2404
Dave Houlton533be9f2018-03-26 17:08:30 -06002405 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002406 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2407 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2408 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002409 }
2410
Dave Houltonc991cc92018-03-06 11:08:51 -07002411 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002412 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002413 if (FormatIsCompressed(src_state->createInfo.format) ||
2414 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002415 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002416 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002417 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2418 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2419 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002420 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002421 skip |= LogError(src_state->image, vuid,
2422 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2423 "texel width & height (%d, %d).",
2424 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002425 }
2426
Dave Houlton94a00372017-12-14 15:08:47 -07002427 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002428 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2429 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002430 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
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 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2435 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002436 }
2437
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002438 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002439 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2440 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002441 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002442 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002443 LogError(src_state->image, vuid,
2444 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2445 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2446 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002447 }
2448
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002449 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002450 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2451 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002452 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002453 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002454 LogError(src_state->image, vuid,
2455 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2456 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2457 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002458 }
2459 } // Compressed
2460
2461 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002462 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002463 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002464 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2465 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2466 "these must be 0 and 1, respectively.",
2467 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002468 }
2469 }
2470
Dave Houlton533be9f2018-03-26 17:08:30 -06002471 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 -07002472 skip |=
2473 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2474 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2475 "and 1, respectively.",
2476 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002477 }
2478
Dave Houlton533be9f2018-03-26 17:08:30 -06002479 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002480 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2481 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2482 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002483 }
2484
sfricke-samsung30b094c2020-05-30 11:42:11 -07002485 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002486 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002487 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2488 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
2489 skip |=
2490 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2491 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2492 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2493 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2494 }
2495 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002496 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002497 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002498 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002499 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2500 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2501 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2502 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002503 }
2504 }
2505 } else { // Pre maint 1
2506 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002507 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
2508 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00139",
2509 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2510 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2511 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2512 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2513 }
Dave Houltonee281a52017-12-08 13:51:02 -07002514 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002515 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00139",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002516 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2517 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2518 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2519 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002520 }
2521 }
2522 }
2523
Dave Houltonc991cc92018-03-06 11:08:51 -07002524 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2525 if (FormatIsCompressed(dst_state->createInfo.format) ||
2526 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002527 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002528
2529 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002530 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2531 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2532 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002533 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002534 skip |= LogError(dst_state->image, vuid,
2535 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2536 "texel width & height (%d, %d).",
2537 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002538 }
2539
Dave Houlton94a00372017-12-14 15:08:47 -07002540 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002541 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2542 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002543 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002544 skip |= LogError(
2545 dst_state->image, vuid,
2546 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2547 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2548 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002549 }
2550
Dave Houltonee281a52017-12-08 13:51:02 -07002551 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2552 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2553 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002554 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002555 skip |= LogError(dst_state->image, vuid,
2556 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2557 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2558 "height (%d).",
2559 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002560 }
2561
Dave Houltonee281a52017-12-08 13:51:02 -07002562 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2563 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2564 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002565 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002566 skip |= LogError(
2567 dst_state->image, vuid,
2568 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2569 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2570 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002571 }
2572 } // Compressed
2573 }
2574 return skip;
2575}
2576
Dave Houltonc991cc92018-03-06 11:08:51 -07002577// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002578bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002579 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002580 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002581
2582 // Neither image is multiplane
2583 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2584 // If neither image is multi-plane the aspectMask member of src and dst must match
2585 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2586 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002587 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002588 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002589 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002590 }
2591 } else {
2592 // Source image multiplane checks
2593 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2594 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2595 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2596 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002597 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002598 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002599 }
2600 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2601 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2602 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002603 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002604 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002605 }
2606 // Single-plane to multi-plane
2607 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2608 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2609 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002610 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002611 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002612 }
2613
2614 // Dest image multiplane checks
2615 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2616 aspect = region.dstSubresource.aspectMask;
2617 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2618 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002619 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002620 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002621 }
2622 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2623 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2624 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002625 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002626 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002627 }
2628 // Multi-plane to single-plane
2629 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2630 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2631 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002632 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002633 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002634 }
2635 }
2636
2637 return skip;
2638}
2639
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002640bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2641 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002642 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002643 const auto *cb_node = GetCBState(commandBuffer);
2644 const auto *src_image_state = GetImageState(srcImage);
2645 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002646 const VkFormat src_format = src_image_state->createInfo.format;
2647 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002648 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002649
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002650 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002651
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002652 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2653
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002654 for (uint32_t i = 0; i < regionCount; i++) {
2655 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002656
2657 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2658 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002659 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002660
Dave Houlton6f9059e2017-05-02 17:15:13 -06002661 bool slice_override = false;
2662 uint32_t depth_slices = 0;
2663
2664 // Special case for copying between a 1D/2D array and a 3D image
2665 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2666 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2667 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002668 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002669 slice_override = (depth_slices != 1);
2670 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2671 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002672 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002673 slice_override = (depth_slices != 1);
2674 }
2675
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002676 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2677 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2678 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002679 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002680 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002681 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002682 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002683 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2684 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002685 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002686 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2687 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002688
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002689 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002690 // No chance of mismatch if we're overriding depth slice count
2691 if (!slice_override) {
2692 // The number of depth slices in srcSubresource and dstSubresource must match
2693 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2694 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002695 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2696 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002697 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002698 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2699 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002700 if (src_slices != dst_slices) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002701 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140",
2702 "vkCmdCopyImage(): number of depth slices in source and destination subresources for "
2703 "pRegions[%u] do not match.",
2704 i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002705 }
2706 }
2707 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002708 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002709 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002710 skip |= LogError(
2711 command_buffer, "VUID-VkImageCopy-layerCount-00138",
2712 "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[%u] do not match", i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002713 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002714 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002715
Dave Houltonc991cc92018-03-06 11:08:51 -07002716 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002717 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002718 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002719 }
2720
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002721 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002722 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2723 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002724 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002725 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002726 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002727 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002728
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002729 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002730 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002731 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002732 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002733 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002734 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002735 }
2736
2737 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002738 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002739 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002740 ss << "vkCmdCopyImage(): pRegion[" << i
2741 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002742 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002743 }
2744
Dave Houltonfc1a4052017-04-27 14:32:45 -06002745 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002746 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2747 if (slice_override) src_copy_extent.depth = depth_slices;
2748 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002749 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002750 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002751 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2752 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2753 "width [%1d].",
2754 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002755 }
2756
2757 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002758 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002759 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2760 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2761 "height [%1d].",
2762 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002763 }
2764 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002765 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002766 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2767 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2768 "depth [%1d].",
2769 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002770 }
2771
Dave Houltonee281a52017-12-08 13:51:02 -07002772 // Adjust dest extent if necessary
2773 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2774 if (slice_override) dst_copy_extent.depth = depth_slices;
2775
2776 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002777 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002778 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2779 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2780 "width [%1d].",
2781 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002782 }
2783 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002784 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2785 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2786 "height [%1d].",
2787 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002788 }
2789 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002790 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2791 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2792 "depth [%1d].",
2793 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002794 }
2795
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002796 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2797 // must not overlap in memory
2798 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002799 for (uint32_t j = 0; j < regionCount; j++) {
2800 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002801 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002802 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002803 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002804 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002805 }
2806 }
2807 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002808
2809 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2810 if (device_extensions.vk_khr_maintenance1) {
2811 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2812 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2813 (src_copy_extent.depth != 1)) {
2814 skip |= LogError(
2815 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2816 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2817 src_copy_extent.depth);
2818 }
2819 } else {
2820 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2821 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2822 (src_copy_extent.depth != 1)) {
2823 skip |= LogError(
2824 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2825 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2826 src_copy_extent.depth);
2827 }
2828 }
2829
2830 // Check if 2D with 3D and depth not equal to 2D layerCount
2831 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2832 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2833 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2834 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2835 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2836 "srcSubresource.layerCount (%u)",
2837 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2838 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2839 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2840 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2841 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2842 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2843 "dstSubresource.layerCount (%u)",
2844 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2845 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002846
2847 // Check for multi-plane format compatiblity
2848 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
2849 size_t src_format_size = 0;
2850 size_t dst_format_size = 0;
2851 if (FormatIsMultiplane(src_format)) {
2852 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
2853 src_format_size = FormatElementSize(planeFormat);
2854 } else {
2855 src_format_size = FormatElementSize(src_format);
2856 }
2857 if (FormatIsMultiplane(dst_format)) {
2858 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
2859 dst_format_size = FormatElementSize(planeFormat);
2860 } else {
2861 dst_format_size = FormatElementSize(dst_format);
2862 }
2863 // If size is still zero, then format is invalid and will be caught in another VU
2864 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
2865 skip |=
2866 LogError(command_buffer, "VUID-vkCmdCopyImage-None-01549",
2867 "vkCmdCopyImage(): pRegions[%u] called with non-compatible image formats. "
2868 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
2869 i, string_VkFormat(src_format), string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(),
2870 string_VkFormat(dst_format), string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
2871 }
2872 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002873 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002874
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002875 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
2876 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
2877 // because because both texels are 4 bytes in size.
2878 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
2879 const char *compatible_vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2880 : "VUID-vkCmdCopyImage-srcImage-00135";
2881 // Depth/stencil formats must match exactly.
2882 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2883 if (src_format != dst_format) {
2884 skip |= LogError(command_buffer, compatible_vuid,
2885 "vkCmdCopyImage(): Depth/stencil formats must match exactly for src (%s) and dst (%s).",
2886 string_VkFormat(src_format), string_VkFormat(dst_format));
2887 }
2888 } else {
2889 if (!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) {
2890 skip |= LogError(command_buffer, compatible_vuid,
2891 "vkCmdCopyImage(): Unmatched image format sizes. "
2892 "The src format %s has size of %zu and dst format %s has size of %zu.",
2893 string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
2894 FormatElementSize(dst_format));
2895 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002896 }
2897 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002898
Dave Houlton33c22b72017-02-28 13:16:02 -07002899 // Source and dest image sample counts must match
2900 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2901 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002902 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002903 }
2904
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002905 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2906 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002907 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002908 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2909 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2910 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2911 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02002912
2913 // Validation for VK_EXT_fragment_density_map
2914 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2915 skip |= LogError(
2916 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2917 "vkCmdCopyImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2918 }
2919 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2920 skip |= LogError(
2921 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2922 "vkCmdCopyImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2923 }
2924
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002925 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002926 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002927 "VUID-vkCmdCopyImage-srcImage-01995");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002928 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002929 "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002930 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002931 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002932 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002933 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2934 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002935 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002936 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2937 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2938 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2939 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2940 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2941 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002942 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002943 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002944 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2945 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002946 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002947 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2948 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002949 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2950 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002951 }
2952
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002953 return skip;
2954}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002955
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002956void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2957 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2958 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002959 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2960 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002961 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002962 auto src_image_state = GetImageState(srcImage);
2963 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002964
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002965 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002966 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002967 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2968 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002969 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002970}
2971
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002972// Returns true if sub_rect is entirely contained within rect
2973static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2974 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2975 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2976 return false;
2977 return true;
2978}
2979
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002980bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002981 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2982 const VkRect2D &render_area, uint32_t rect_count,
2983 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002984 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002985 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2986 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06002987 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07002988 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002989
2990 for (uint32_t j = 0; j < rect_count; j++) {
2991 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002992 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2993 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2994 "the current render pass instance.",
2995 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002996 }
2997
2998 if (image_view_state) {
2999 // The layers specified by a given element of pRects must be contained within every attachment that
3000 // pAttachments refers to
3001 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3002 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3003 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003004 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3005 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3006 "of pAttachment[%d].",
3007 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003008 }
3009 }
3010 }
3011 return skip;
3012}
3013
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003014bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3015 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003016 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003017 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003018 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003019 if (!cb_node) return skip;
3020
3021 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3022 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3023 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003024 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003025
3026 // Validate that attachment is in reference list of active subpass
3027 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003028 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003029 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003030 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003031 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07003032 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003033
John Zulauf3a548ef2019-02-01 16:14:07 -07003034 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3035 auto clear_desc = &pAttachments[attachment_index];
3036 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003037
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003038 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003039 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003040 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003041 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003042 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003043 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3044 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3045 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3046 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003047 skip |= LogError(
3048 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3049 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3050 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3051 attachment_index, clear_desc->colorAttachment,
3052 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3053 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003054
John Zulauff2582972019-02-09 14:53:30 -07003055 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3056 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003057 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003058 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3059 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3060 " subpass %u. colorAttachmentCount=%u",
3061 attachment_index, clear_desc->colorAttachment,
3062 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3063 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003064 }
John Zulauff2582972019-02-09 14:53:30 -07003065 fb_attachment = color_attachment;
3066
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003067 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3068 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3069 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003070 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003071 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003072 }
3073 } else { // Must be depth and/or stencil
3074 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
3075 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003076 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003077 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003078 }
3079 if (!subpass_desc->pDepthStencilAttachment ||
3080 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003081 skip |= LogPerformanceWarning(
3082 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003083 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003084 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003085 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003086 }
3087 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003088 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003089 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3090 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003091 }
3092 }
3093 }
3094 return skip;
3095}
3096
3097void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3098 const VkClearAttachment *pAttachments, uint32_t rectCount,
3099 const VkClearRect *pRects) {
3100 auto *cb_node = GetCBState(commandBuffer);
3101 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3102 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3103 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3104 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3105 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3106 const auto clear_desc = &pAttachments[attachment_index];
3107 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3108 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3109 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3110 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3111 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3112 subpass_desc->pDepthStencilAttachment) {
3113 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3114 }
3115 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003116 if (!clear_rect_copy) {
3117 // We need a copy of the clear rectangles that will persist until the last lambda executes
3118 // but we want to create it as lazily as possible
3119 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003120 }
John Zulauf441558b2019-08-12 11:47:39 -06003121 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3122 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003123 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003124 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003125 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003126 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003127 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3128 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003129 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3130 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003131 return skip;
3132 };
3133 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003134 }
3135 }
3136 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003137}
3138
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003139bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3140 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003141 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003142 const auto *cb_node = GetCBState(commandBuffer);
3143 const auto *src_image_state = GetImageState(srcImage);
3144 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003145
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003146 bool skip = false;
3147 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003148 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3149 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003150 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003151 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003152 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3153 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003154 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003155 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003156
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003157 // Validation for VK_EXT_fragment_density_map
3158 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3159 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3160 "vkCmdResolveImage(): srcImage must not have been created with flags containing "
3161 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3162 }
3163 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3164 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3165 "vkCmdResolveImage(): dstImage must not have been created with flags containing "
3166 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3167 }
3168
Cort Stratton7df30962018-05-17 19:45:57 -07003169 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003170 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003171 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003172 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3173 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3174 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003175 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003176 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3177 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003178 // For each region, the number of layers in the image subresource should not be zero
3179 // For each region, src and dest image aspect must be color only
3180 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003181 const VkImageSubresourceLayers src_subresource = pRegions[i].srcSubresource;
3182 const VkImageSubresourceLayers dst_subresource = pRegions[i].dstSubresource;
3183 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, "vkCmdResolveImage()", "srcSubresource", i);
3184 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, "vkCmdResolveImage()", "dstSubresource", i);
3185 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003186 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3187 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003188 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003189 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3190 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003191 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003192 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003193 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003194 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003195 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
3196 src_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003197 "VUID-vkCmdResolveImage-srcSubresource-01711");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003198 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
3199 dst_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003200 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003201
3202 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003203 if (src_subresource.layerCount != dst_subresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003204 skip |= LogError(
3205 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003206 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%u] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003207 }
Cort Stratton7df30962018-05-17 19:45:57 -07003208 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003209 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3210 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3211 skip |= LogError(
3212 cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266",
3213 "vkCmdResolveImage(): src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3214 i);
3215 }
3216
3217 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3218 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3219
3220 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
3221 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount) ||
3222 (0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3223 LogObjectList objlist(cb_node->commandBuffer);
3224 objlist.add(src_image_state->image);
3225 objlist.add(dst_image_state->image);
3226 skip |= LogError(objlist, "VUID-VkImageResolve-srcImage-00268",
3227 "vkCmdResolveImage(): pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
3228 "subresources if the src or dst image is 3D.",
3229 i);
3230 }
3231 }
3232
3233 if (VK_IMAGE_TYPE_1D == src_image_type) {
3234 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3235 LogObjectList objlist(cb_node->commandBuffer);
3236 objlist.add(src_image_state->image);
3237 skip |= LogError(objlist, "VUID-VkImageResolve-srcImage-00271",
3238 "vkCmdResolveImage(): srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
3239 "extent.height (%u) is not 1.",
3240 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.y,
3241 pRegions[i].extent.height);
3242 }
3243 }
3244 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3245 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3246 LogObjectList objlist(cb_node->commandBuffer);
3247 objlist.add(src_image_state->image);
3248 skip |= LogError(objlist, "VUID-VkImageResolve-srcImage-00273",
3249 "vkCmdResolveImage(): srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
3250 "extent.depth (%u) is not 1.",
3251 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.z,
3252 pRegions[i].extent.depth);
3253 }
3254 }
3255
3256 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3257 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3258 LogObjectList objlist(cb_node->commandBuffer);
3259 objlist.add(dst_image_state->image);
3260 skip |= LogError(objlist, "VUID-VkImageResolve-dstImage-00276",
3261 "vkCmdResolveImage(): dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
3262 "extent.height (%u) is not 1.",
3263 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.y,
3264 pRegions[i].extent.height);
3265 }
3266 }
3267 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3268 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3269 LogObjectList objlist(cb_node->commandBuffer);
3270 objlist.add(dst_image_state->image);
3271 skip |= LogError(objlist, "VUID-VkImageResolve-dstImage-00278",
3272 "vkCmdResolveImage(): dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
3273 "extent.depth (%u) is not 1.",
3274 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.z,
3275 pRegions[i].extent.depth);
3276 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003277 }
3278 }
3279
3280 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003281 skip |=
3282 LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-01386",
3283 "vkCmdResolveImage(): srcImage format (%s) and dstImage format (%s) are not the same.",
3284 string_VkFormat(src_image_state->createInfo.format), string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003285 }
3286 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003287 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
3288 "vkCmdResolveImage(): srcImage type (%s) and dstImage type (%s) are not the same.",
3289 string_VkImageType(src_image_state->createInfo.imageType),
3290 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003291 }
3292 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003293 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257",
3294 "vkCmdResolveImage(): srcImage sample count is VK_SAMPLE_COUNT_1_BIT.");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003295 }
3296 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003297 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259",
3298 "vkCmdResolveImage(): dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3299 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003300 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003301 } else {
3302 assert(0);
3303 }
3304 return skip;
3305}
3306
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003307bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3308 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003309 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003310 const auto *cb_node = GetCBState(commandBuffer);
3311 const auto *src_image_state = GetImageState(srcImage);
3312 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003313
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003314 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003315 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003316 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003317 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003318 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003319 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003320 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003321 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003322 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003323 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3324 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003325 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003326 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3327 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003328 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003329 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3330 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003331 skip |=
3332 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003333 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3334 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003335 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003336 "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003337 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003338 "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003339
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003340 // Validation for VK_EXT_fragment_density_map
3341 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3342 skip |= LogError(
3343 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3344 "vkCmdBlitImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3345 }
3346 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3347 skip |= LogError(
3348 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3349 "vkCmdBlitImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3350 }
3351
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003352 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003353
Dave Houlton33c2d252017-06-09 17:08:32 -06003354 VkFormat src_format = src_image_state->createInfo.format;
3355 VkFormat dst_format = dst_image_state->createInfo.format;
3356 VkImageType src_type = src_image_state->createInfo.imageType;
3357 VkImageType dst_type = dst_image_state->createInfo.imageType;
3358
Cort Stratton186b1a22018-05-01 20:18:06 -04003359 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003360 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003361 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003362 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003363 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003364 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003365 }
3366
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003367 if (FormatRequiresYcbcrConversion(src_format)) {
3368 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3369 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3370 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3371 string_VkFormat(src_format));
3372 }
3373
3374 if (FormatRequiresYcbcrConversion(dst_format)) {
3375 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3376 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3377 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3378 string_VkFormat(dst_format));
3379 }
3380
Dave Houlton33c2d252017-06-09 17:08:32 -06003381 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003382 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3383 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003384 }
3385
Dave Houlton33c2d252017-06-09 17:08:32 -06003386 // Validate consistency for unsigned formats
3387 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3388 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003389 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003390 << "the other one must also have unsigned integer format. "
3391 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003392 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003393 }
3394
3395 // Validate consistency for signed formats
3396 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3397 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003398 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003399 << "the other one must also have signed integer format. "
3400 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003401 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003402 }
3403
3404 // Validate filter for Depth/Stencil formats
3405 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3406 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003407 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003408 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003409 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003410 }
3411
3412 // Validate aspect bits and formats for depth/stencil images
3413 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3414 if (src_format != dst_format) {
3415 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003416 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003417 << "stencil, the other one must have exactly the same format. "
3418 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3419 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003420 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003421 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003422 } // Depth or Stencil
3423
3424 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003425 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003426 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003427 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3428 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3429 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003430 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003431 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3432 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003433 for (uint32_t i = 0; i < regionCount; i++) {
3434 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003435 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003436 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003437 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3438 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003439 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003440 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3441 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003442 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3443 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3444 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003445 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003446 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003447 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003448 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003449 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3450 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003451 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003452 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3453 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003454 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003455 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3456 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003457 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003458 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003459 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003460 }
Dave Houlton48989f32017-05-26 15:01:46 -06003461 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3462 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003463 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003464 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003465 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003466 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003467
3468 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003469 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003470 skip |= LogError(
3471 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003472 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003473 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003474
Dave Houlton48989f32017-05-26 15:01:46 -06003475 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003476 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3477 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003478 }
Dave Houlton48989f32017-05-26 15:01:46 -06003479
Dave Houlton33c2d252017-06-09 17:08:32 -06003480 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003481 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3482 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3483 "image format %s.",
3484 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003485 }
3486
3487 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003488 skip |= LogError(
3489 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003490 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3491 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003492 }
3493
Dave Houlton48989f32017-05-26 15:01:46 -06003494 // Validate source image offsets
3495 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003496 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003497 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003498 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003499 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3500 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3501 "of (%1d, %1d). These must be (0, 1).",
3502 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003503 }
3504 }
3505
Dave Houlton33c2d252017-06-09 17:08:32 -06003506 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003507 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003508 skip |=
3509 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3510 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3511 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3512 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003513 }
3514 }
3515
Dave Houlton33c2d252017-06-09 17:08:32 -06003516 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003517 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3518 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003519 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003520 skip |= LogError(
3521 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003522 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3523 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003524 }
3525 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3526 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003527 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003528 skip |= LogError(
3529 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003530 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003531 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003532 }
3533 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3534 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003535 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003536 skip |= LogError(
3537 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003538 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3539 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003540 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003541 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003542 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3543 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003544 }
Dave Houlton48989f32017-05-26 15:01:46 -06003545
3546 // Validate dest image offsets
3547 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003548 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003549 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003550 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003551 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3552 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3553 "(%1d, %1d). These must be (0, 1).",
3554 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003555 }
3556 }
3557
Dave Houlton33c2d252017-06-09 17:08:32 -06003558 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003559 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003560 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3561 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3562 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3563 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003564 }
3565 }
3566
Dave Houlton33c2d252017-06-09 17:08:32 -06003567 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003568 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3569 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003570 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003571 skip |= LogError(
3572 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003573 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3574 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003575 }
3576 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3577 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003578 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003579 skip |= LogError(
3580 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003581 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003582 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003583 }
3584 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3585 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003586 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003587 skip |= LogError(
3588 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003589 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3590 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003591 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003592 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003593 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3594 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003595 }
3596
Dave Houlton33c2d252017-06-09 17:08:32 -06003597 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3598 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3599 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003600 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003601 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3602 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3603 "layerCount other than 1.",
3604 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003605 }
3606 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003607 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003608 } else {
3609 assert(0);
3610 }
3611 return skip;
3612}
3613
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003614void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3615 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3616 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003617 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3618 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003619 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003620 auto src_image_state = GetImageState(srcImage);
3621 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003622
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003623 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003624 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003625 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3626 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003627 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003628}
3629
John Zulauf2076e812020-01-08 14:55:54 -07003630GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3631 assert(map);
3632 // This approach allows for a single hash lookup or/create new
3633 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3634 if (inserted.second) {
3635 assert(nullptr == inserted.first->second.get());
3636 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.range_encoder.SubresourceCount());
3637 inserted.first->second.reset(layout_map);
3638 return layout_map;
3639 } else {
3640 assert(nullptr != inserted.first->second.get());
3641 return inserted.first->second.get();
3642 }
3643 return nullptr;
3644}
3645
3646const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3647 auto it = map.find(image);
3648 if (it != map.end()) {
3649 return it->second.get();
3650 }
3651 return nullptr;
3652}
3653
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003654// 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 -07003655bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3656 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06003657 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003658 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003659 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003660 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003661 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003662 for (const auto &layout_map_entry : pCB->image_layout_map) {
3663 const auto image = layout_map_entry.first;
3664 const auto *image_state = GetImageState(image);
3665 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003666 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003667 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003668 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003669 if (initial_layout_map.empty()) continue;
3670
3671 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3672 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3673 if (global_map == nullptr) {
3674 global_map = &empty_map;
3675 }
3676
3677 // Note: don't know if it would matter
3678 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3679
3680 auto pos = initial_layout_map.begin();
3681 const auto end = initial_layout_map.end();
3682 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3683 pos->first.begin);
3684 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003685 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003686 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003687 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 -07003688 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003689 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003690 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003691 image_layout = current_layout->pos_B->lower_bound->second;
3692 }
3693 const auto intersected_range = pos->first & current_layout->range;
3694 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3695 // TODO: Set memory invalid which is in mem_tracker currently
3696 } else if (image_layout != initial_layout) {
3697 // Need to look up the inital layout *state* to get a bit more information
3698 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3699 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3700 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3701 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07003702 // We can report all the errors for the intersected range directly
3703 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
3704 const auto subresource = image_state->range_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003705 skip |= LogError(
3706 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003707 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003708 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07003709 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003710 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06003711 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003712 }
3713 }
John Zulauf2076e812020-01-08 14:55:54 -07003714 if (pos->first.includes(intersected_range.end)) {
3715 current_layout.seek(intersected_range.end);
3716 } else {
3717 ++pos;
3718 if (pos != end) {
3719 current_layout.seek(pos->first.begin);
3720 }
3721 }
John Zulauff660ad62019-03-23 07:16:05 -06003722 }
3723
locke-lunargf155ccf2020-02-18 11:34:15 -07003724 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003725 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003726 }
John Zulauff660ad62019-03-23 07:16:05 -06003727
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003728 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003729}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003730
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003731void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003732 for (const auto &layout_map_entry : pCB->image_layout_map) {
3733 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003734 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003735 const auto *image_state = GetImageState(image);
3736 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003737 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3738 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003739 }
3740}
3741
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003742// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003743// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3744// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003745bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3746 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003747 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003748 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003749 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3750
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003751 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07003752 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
3753 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003754 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003755 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3756 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3757 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003758 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003759 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003760 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07003761 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3762 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
3763 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003764 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003765 string_VkImageLayout(first_layout));
3766 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3767 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003768 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003769 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003770 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003771 }
3772 }
sfricke-samsung55f01952020-03-24 08:16:41 -07003773
3774 // Same as above for loadOp, but for stencilLoadOp
3775 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3776 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3777 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3778 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
3779 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003780 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003781 string_VkImageLayout(first_layout));
3782 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3783 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
3784 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003785 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003786 string_VkImageLayout(first_layout));
3787 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3788 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3789 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003790 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003791 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003792 }
3793 }
3794
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003795 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003796}
3797
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003798bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3799 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003800 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003801 const char *vuid;
3802 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003803
Jason Ekstranda1906302017-12-03 20:16:32 -08003804 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3805 VkFormat format = pCreateInfo->pAttachments[i].format;
3806 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3807 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3808 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003809 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003810 "%s: Render pass pAttachment[%u] has loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003811 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3812 "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 -07003813 "render pass.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003814 function_name, i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003815 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003816 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003817 skip |=
3818 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3819 "%s: Render pass pAttachment[%u] has stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3820 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3821 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3822 "render pass.",
3823 function_name, i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003824 }
3825 }
3826 }
3827
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003828 // Track when we're observing the first use of an attachment
3829 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3830 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003831 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003832
3833 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3834 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3835 auto attach_index = subpass.pInputAttachments[j].attachment;
3836 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003837 switch (subpass.pInputAttachments[j].layout) {
3838 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3839 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3840 // These are ideal.
3841 break;
3842
3843 case VK_IMAGE_LAYOUT_GENERAL:
3844 // May not be optimal. TODO: reconsider this warning based on other constraints.
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003845 skip |= LogPerformanceWarning(
3846 device, kVUID_Core_DrawState_InvalidImageLayout,
3847 "%s: Layout for input attachment reference %u in subpass %u is GENERAL but should be READ_ONLY_OPTIMAL.",
3848 function_name, j, i);
Cort Stratton7547f772017-05-04 15:18:52 -07003849 break;
3850
Tobias Hectorbbb12282018-10-22 15:17:59 +01003851 case VK_IMAGE_LAYOUT_UNDEFINED:
3852 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003853 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003854 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003855 "%s: Layout for input attachment reference %u in subpass %u is %s but must be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003856 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003857 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003858 break;
3859
Piers Daniell9af77cd2019-10-16 13:54:12 -06003860 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3861 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3862 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3863 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003864 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003865 skip |= LogError(
3866 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003867 "%s: Layout for input attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06003868 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3869 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003870 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06003871 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003872 skip |= LogError(
3873 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003874 "%s: Layout for input attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06003875 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3876 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003877 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06003878 } else if ((subpass.pInputAttachments[j].aspectMask &
3879 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3880 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3881 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3882 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3883 const auto *attachment_reference_stencil_layout =
3884 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3885 if (attachment_reference_stencil_layout) {
3886 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3887 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3888 attachment_reference_stencil_layout->stencilLayout ==
3889 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3890 attachment_reference_stencil_layout->stencilLayout ==
3891 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3892 attachment_reference_stencil_layout->stencilLayout ==
3893 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3894 attachment_reference_stencil_layout->stencilLayout ==
3895 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3896 attachment_reference_stencil_layout->stencilLayout ==
3897 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3898 attachment_reference_stencil_layout->stencilLayout ==
3899 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3900 attachment_reference_stencil_layout->stencilLayout ==
3901 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3902 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003903 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003904 "%s: In the attachment reference %u in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003905 "VkAttachmentReferenceStencilLayoutKHR"
3906 "the stencilLayout member but must not be "
3907 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3908 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3909 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3910 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3911 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3912 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3913 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3914 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3915 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003916 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003917 }
3918 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003919 skip |= LogError(
3920 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003921 "%s: When the layout for input attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003922 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3923 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3924 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003925 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003926 }
3927 }
3928 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3929 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3930 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003931 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03315",
3932 "%s: When the aspectMask for input attachment reference %u in subpass %u is "
3933 "VK_IMAGE_ASPECT_DEPTH_BIT "
3934 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3935 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3936 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003937 }
3938 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3939 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3940 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003941 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003942 "%s: When the aspectMask for input attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003943 "VK_IMAGE_ASPECT_STENCIL_BIT "
3944 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3945 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003946 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003947 }
3948 }
3949 break;
3950
Graeme Leese668a9862018-10-08 10:40:02 +01003951 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3952 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003953 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003954 break;
3955 } else {
3956 // Intentionally fall through to generic error message
3957 }
3958 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003959
Cort Stratton7547f772017-05-04 15:18:52 -07003960 default:
3961 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003962 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003963 "%s: Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3964 function_name, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003965 }
3966
Cort Stratton7547f772017-05-04 15:18:52 -07003967 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003968 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3969 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003970
3971 bool used_as_depth =
3972 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3973 bool used_as_color = false;
3974 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3975 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3976 }
3977 if (!used_as_depth && !used_as_color &&
3978 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003979 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003980 skip |= LogError(device, vuid,
3981 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
Mark Lobodzinski6ff146b2020-05-22 14:37:05 -06003982 function_name, attach_index, i);
Cort Stratton7547f772017-05-04 15:18:52 -07003983 }
3984 }
3985 attach_first_use[attach_index] = false;
3986 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003987
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003988 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3989 auto attach_index = subpass.pColorAttachments[j].attachment;
3990 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3991
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003992 // TODO: Need a way to validate shared presentable images here, currently just allowing
3993 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3994 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003995 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003996 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003997 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003998 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3999 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004000 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004001
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004002 case VK_IMAGE_LAYOUT_GENERAL:
4003 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004004 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004005 "%s: Layout for color attachment reference %u in subpass %u is GENERAL but "
4006 "should be COLOR_ATTACHMENT_OPTIMAL.",
4007 function_name, j, i);
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004008 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004009
Tobias Hectorbbb12282018-10-22 15:17:59 +01004010 case VK_IMAGE_LAYOUT_UNDEFINED:
4011 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004012 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004013 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004014 "%s: Layout for color attachment reference %u in subpass %u is %s but should be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004015 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004016 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004017 break;
4018
Piers Daniell9af77cd2019-10-16 13:54:12 -06004019 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4020 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4021 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4022 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004023 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004024 skip |= LogError(
4025 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004026 "%s: Layout for color attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004027 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4028 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004029 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004030 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004031 skip |= LogError(
4032 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004033 "%s: Layout for color attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004034 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4035 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004036 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004037 } else if ((subpass.pColorAttachments[j].aspectMask &
4038 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4039 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4040 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4041 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4042 const auto *attachment_reference_stencil_layout =
4043 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
4044 if (attachment_reference_stencil_layout) {
4045 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4046 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4047 attachment_reference_stencil_layout->stencilLayout ==
4048 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4049 attachment_reference_stencil_layout->stencilLayout ==
4050 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4051 attachment_reference_stencil_layout->stencilLayout ==
4052 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4053 attachment_reference_stencil_layout->stencilLayout ==
4054 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4055 attachment_reference_stencil_layout->stencilLayout ==
4056 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4057 attachment_reference_stencil_layout->stencilLayout ==
4058 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4059 attachment_reference_stencil_layout->stencilLayout ==
4060 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4061 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004062 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004063 "%s: In the attachment reference %u in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004064 "VkAttachmentReferenceStencilLayoutKHR"
4065 "the stencilLayout member but must not be "
4066 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4067 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4068 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4069 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4070 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4071 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4072 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4073 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4074 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004075 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004076 }
4077 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004078 skip |= LogError(
4079 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004080 "%s: When the layout for color attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004081 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4082 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4083 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004084 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004085 }
4086 }
4087 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4088 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4089 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004090 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03315",
4091 "%s: When the aspectMask for color attachment reference %u in subpass %u is "
4092 "VK_IMAGE_ASPECT_DEPTH_BIT "
4093 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4094 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4095 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004096 }
4097 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4098 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4099 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004100 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004101 "%s: When the aspectMask for color attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004102 "VK_IMAGE_ASPECT_STENCIL_BIT "
4103 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4104 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004105 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004106 }
4107 }
4108 break;
4109
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004110 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004111 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004112 "%s: Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
4113 function_name, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004114 }
4115
John Zulauf4eee2692019-02-09 16:14:25 -07004116 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
4117 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
4118 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08004119 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004120 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004121 "%s: Layout for resolve attachment reference %u in subpass %u is %s but should be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004122 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004123 function_name, j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004124 }
4125
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004126 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004127 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
4128 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004129 }
4130 attach_first_use[attach_index] = false;
4131 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004132
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004133 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
4134 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004135 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
4136 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
4137 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06004138 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06004139
Dave Houltona9df0ce2018-02-07 10:51:23 -07004140 case VK_IMAGE_LAYOUT_GENERAL:
4141 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
4142 // doing a bunch of transitions.
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004143 skip |= LogPerformanceWarning(
4144 device, kVUID_Core_DrawState_InvalidImageLayout,
4145 "%s: GENERAL layout for depth attachment reference in subpass %u may not give optimal performance.",
4146 function_name, i);
Dave Houltona9df0ce2018-02-07 10:51:23 -07004147 break;
4148
Tobias Hectorbbb12282018-10-22 15:17:59 +01004149 case VK_IMAGE_LAYOUT_UNDEFINED:
4150 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004151 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004152 skip |=
4153 LogError(device, vuid,
4154 "%s: Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
4155 "layout or GENERAL.",
4156 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004157 break;
4158
Piers Daniell9af77cd2019-10-16 13:54:12 -06004159 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4160 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4161 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4162 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004163 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004164 skip |= LogError(
4165 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004166 "%s: Layout for depth attachment reference in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004167 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4168 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004169 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004170 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004171 skip |= LogError(
4172 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004173 "%s: Layout for depth attachment reference in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004174 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4175 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004176 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004177 } else if ((subpass.pDepthStencilAttachment->aspectMask &
4178 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4179 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4180 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4181 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4182 const auto *attachment_reference_stencil_layout =
4183 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
4184 if (attachment_reference_stencil_layout) {
4185 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4186 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4187 attachment_reference_stencil_layout->stencilLayout ==
4188 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4189 attachment_reference_stencil_layout->stencilLayout ==
4190 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4191 attachment_reference_stencil_layout->stencilLayout ==
4192 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4193 attachment_reference_stencil_layout->stencilLayout ==
4194 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4195 attachment_reference_stencil_layout->stencilLayout ==
4196 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4197 attachment_reference_stencil_layout->stencilLayout ==
4198 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4199 attachment_reference_stencil_layout->stencilLayout ==
4200 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4201 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004202 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004203 "%s: In the attachment reference in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004204 "VkAttachmentReferenceStencilLayoutKHR"
4205 "the stencilLayout member but must not be "
4206 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4207 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4208 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4209 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4210 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4211 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4212 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4213 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4214 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004215 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004216 }
4217 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004218 skip |= LogError(
4219 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004220 "%s: When the layout for depth attachment reference in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004221 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4222 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4223 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004224 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004225 }
4226 }
4227 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4228 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4229 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004230 skip |= LogError(
4231 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004232 "%s: When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004233 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4234 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004235 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004236 }
4237 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4238 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4239 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004240 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004241 "%s: When the aspectMask for depth attachment reference in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004242 "VK_IMAGE_ASPECT_STENCIL_BIT "
4243 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4244 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004245 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004246 }
4247 }
4248 break;
4249
Dave Houltona9df0ce2018-02-07 10:51:23 -07004250 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4251 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004252 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004253 break;
4254 } else {
4255 // Intentionally fall through to generic error message
4256 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004257 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004258
Dave Houltona9df0ce2018-02-07 10:51:23 -07004259 default:
4260 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004261 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004262 "%s: Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004263 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004264 function_name, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004265 }
4266
4267 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4268 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004269 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4270 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004271 }
4272 attach_first_use[attach_index] = false;
4273 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004274 }
4275 return skip;
4276}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004277
Mark Lobodzinski96210742017-02-09 10:33:46 -07004278// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4279// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004280template <typename T1>
4281bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4282 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4283 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004284 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004285 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004286 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004287 if (strict) {
4288 correct_usage = ((actual & desired) == desired);
4289 } else {
4290 correct_usage = ((actual & desired) != 0);
4291 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004292
Mark Lobodzinski96210742017-02-09 10:33:46 -07004293 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004294 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004295 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004296 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
4297 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4298 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004299 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004300 skip = LogError(object, msgCode,
4301 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4302 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004303 }
4304 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004305 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004306}
4307
4308// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4309// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004310bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004311 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004312 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004313 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004314}
4315
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004316bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004317 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004318 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004319 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4320 if ((image_format_features & desired) != desired) {
4321 // Same error, but more details if it was an AHB external format
4322 if (image_state->has_ahb_format == true) {
4323 skip |= LogError(image_state->image, vuid,
4324 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4325 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4326 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004327 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004328 } else {
4329 skip |= LogError(image_state->image, vuid,
4330 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4331 "with tiling %s.",
4332 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4333 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4334 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004335 }
4336 }
4337 return skip;
4338}
4339
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004340bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004341 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004342 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004343 // layerCount must not be zero
4344 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004345 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4346 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004347 }
4348 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4349 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004350 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4351 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004352 }
4353 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4354 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4355 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004356 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4357 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4358 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4359 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004360 }
4361 return skip;
4362}
4363
Mark Lobodzinski96210742017-02-09 10:33:46 -07004364// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4365// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004366bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004367 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004368 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004369 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004370}
4371
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004372bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004373 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004374 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004375
4376 const VkDeviceSize &range = pCreateInfo->range;
4377 if (range != VK_WHOLE_SIZE) {
4378 // Range must be greater than 0
4379 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004380 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004381 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004382 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4383 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004384 }
4385 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004386 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4387 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004388 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004389 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004390 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4391 "(%" PRIu32 ").",
4392 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004393 }
4394 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004395 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004396 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004397 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004398 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4399 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4400 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004401 }
4402 // The sum of range and offset must be less than or equal to the size of buffer
4403 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004404 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004405 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004406 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4407 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4408 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004409 }
4410 }
4411 return skip;
4412}
4413
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004414bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004415 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004416 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004417 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4418 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004419 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004420 "vkCreateBufferView(): If buffer was created with `usage` containing "
4421 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004422 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004423 }
4424 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4425 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004426 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004427 "vkCreateBufferView(): If buffer was created with `usage` containing "
4428 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004429 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004430 }
4431 return skip;
4432}
4433
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004434bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004435 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004436 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004437
Dave Houltond8ed0212018-05-16 17:18:24 -06004438 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004439
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004440 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004441 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4442 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4443 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004444 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004445
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004446 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004447 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4448 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4449 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004450 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004451
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004452 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004453 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4454 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4455 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004456 }
Jeff Bolz87697532019-01-11 22:54:00 -06004457
4458 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4459 if (chained_devaddr_struct) {
4460 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4461 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004462 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4463 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4464 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004465 }
4466 }
4467
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004468 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4469 if (chained_opaqueaddr_struct) {
4470 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4471 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004472 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4473 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4474 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004475 }
4476 }
4477
Shannon McPherson4984e642019-12-05 13:04:34 -07004478 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004479 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4480 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004481 skip |= LogError(
4482 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004483 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4484 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4485 }
4486
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004487 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004488 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4489 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4490 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004491 }
4492
Mark Lobodzinski96210742017-02-09 10:33:46 -07004493 return skip;
4494}
4495
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004496bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004497 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004498 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004499 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004500 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4501 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004502 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004503 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4504 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004505 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004506 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4507 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4508 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004509
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004510 // Buffer view offset must be less than the size of buffer
4511 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004512 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004513 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004514 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4515 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004516 }
4517
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004518 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004519 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4520 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4521 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004522 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4523 : "VUID-VkBufferViewCreateInfo-offset-00926";
4524 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004525 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004526 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4527 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004528 }
4529
4530 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4531 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4532 if ((elementSize % 3) == 0) {
4533 elementSize /= 3;
4534 }
4535 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4536 VkDeviceSize alignmentRequirement =
4537 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4538 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4539 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4540 }
4541 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004542 skip |= LogError(
4543 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004544 "vkCreateBufferView(): If buffer was created with usage containing "
4545 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004546 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4547 ") must be a multiple of the lesser of "
4548 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4549 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4550 "(%" PRId32
4551 ") is VK_TRUE, the size of a texel of the requested format. "
4552 "If the size of a texel is a multiple of three bytes, then the size of a "
4553 "single component of format is used instead",
4554 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4555 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4556 }
4557 }
4558 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4559 VkDeviceSize alignmentRequirement =
4560 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4561 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4562 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4563 }
4564 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004565 skip |= LogError(
4566 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004567 "vkCreateBufferView(): If buffer was created with usage containing "
4568 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004569 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4570 ") must be a multiple of the lesser of "
4571 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4572 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4573 "(%" PRId32
4574 ") is VK_TRUE, the size of a texel of the requested format. "
4575 "If the size of a texel is a multiple of three bytes, then the size of a "
4576 "single component of format is used instead",
4577 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4578 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4579 }
4580 }
4581 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004582
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004583 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004584
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004585 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004586 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004587 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004588}
4589
Mark Lobodzinski602de982017-02-09 11:01:33 -07004590// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004591bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004592 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004593 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004594 const IMAGE_STATE *image_state = GetImageState(image);
4595 // checks color format and (single-plane or non-disjoint)
4596 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004597 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004598 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004599 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 -07004600 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004601 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 -07004602 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004603 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004604 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004605 skip |= LogError(image, vuid,
4606 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4607 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4608 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004609 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004610 skip |= LogError(image, vuid,
4611 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4612 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4613 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004614 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004615 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004616 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004617 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 -07004618 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004619 skip |=
4620 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 -07004621 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004622 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004623 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004624 skip |=
4625 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 -07004626 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004627 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4628 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004629 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004630 } else if (FormatIsMultiplane(format)) {
4631 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4632 if (3 == FormatPlaneCount(format)) {
4633 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4634 }
4635 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004636 skip |=
4637 LogError(image, vuid,
4638 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4639 "set, where n = [0, 1, 2].",
4640 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004641 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004642 }
4643 return skip;
4644}
4645
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004646bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4647 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004648 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4649 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004650 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004651
4652 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004653 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004654 skip |= LogError(image, errorCodes.base_mip_err,
4655 "%s: %s.baseMipLevel (= %" PRIu32
4656 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4657 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004658 }
Petr Kraus4d718682017-05-18 03:38:41 +02004659
Petr Krausffa94af2017-08-08 21:46:02 +02004660 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4661 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004662 skip |=
4663 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004664 } else {
4665 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004666
Petr Krausffa94af2017-08-08 21:46:02 +02004667 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004668 skip |= LogError(image, errorCodes.mip_count_err,
4669 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4670 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4671 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4672 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004673 }
Petr Kraus4d718682017-05-18 03:38:41 +02004674 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004675 }
Petr Kraus4d718682017-05-18 03:38:41 +02004676
4677 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004678 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004679 skip |= LogError(image, errorCodes.base_layer_err,
4680 "%s: %s.baseArrayLayer (= %" PRIu32
4681 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4682 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004683 }
Petr Kraus4d718682017-05-18 03:38:41 +02004684
Petr Krausffa94af2017-08-08 21:46:02 +02004685 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4686 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004687 skip |=
4688 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004689 } else {
4690 const uint64_t necessary_layer_count =
4691 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004692
Petr Krausffa94af2017-08-08 21:46:02 +02004693 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004694 skip |= LogError(image, errorCodes.layer_count_err,
4695 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4696 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4697 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4698 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004699 }
Petr Kraus4d718682017-05-18 03:38:41 +02004700 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004701 }
Petr Kraus4d718682017-05-18 03:38:41 +02004702
Mark Lobodzinski602de982017-02-09 11:01:33 -07004703 return skip;
4704}
4705
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004706bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004707 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004708 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004709 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4710 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4711 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4712
4713 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4714 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4715
4716 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004717 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4718 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004719 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004720 : "VUID-VkImageViewCreateInfo-image-01482")
4721 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4722 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004723 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004724 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4725 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004726
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004727 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004728 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004729 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004730}
4731
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004732bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004733 const VkImageSubresourceRange &subresourceRange,
4734 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004735 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004736 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4737 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4738 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4739 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004740
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004741 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004742 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004743 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004744}
4745
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004746bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004747 const VkImageSubresourceRange &subresourceRange,
4748 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004749 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004750 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4751 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4752 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4753 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004754
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004755 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004756 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4757 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004758}
4759
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004760bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004761 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004762 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004763 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004764 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4765 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4766 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4767 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004768
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004769 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004770 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004771}
4772
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004773bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4774 const VkImageUsageFlags image_usage) const {
4775 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4776 bool skip = false;
4777
4778 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4779 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4780
4781 if (image_state->has_ahb_format == true) {
4782 // AHB image view and image share same feature sets
4783 tiling_features = image_state->format_features;
4784 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4785 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4786 assert(device_extensions.vk_ext_image_drm_format_modifier);
4787 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4788 nullptr};
4789 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4790
4791 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4792 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4793 nullptr};
4794 format_properties_2.pNext = (void *)&drm_properties_list;
4795 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4796
4797 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4798 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4799 0) {
4800 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4801 }
4802 }
4803 } else {
4804 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4805 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4806 : format_properties.optimalTilingFeatures;
4807 }
4808
4809 if (tiling_features == 0) {
4810 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4811 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4812 "physical device.",
4813 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4814 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4815 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4816 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4817 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4818 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4819 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4820 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4821 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4822 "VK_IMAGE_USAGE_STORAGE_BIT.",
4823 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4824 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4825 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4826 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4827 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4828 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4829 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4830 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4831 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4832 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4833 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4834 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4835 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4836 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4837 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4838 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4839 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4840 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4841 }
4842
4843 return skip;
4844}
4845
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004846bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004847 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004848 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004849 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004850 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004851 skip |=
4852 ValidateImageUsageFlags(image_state,
4853 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4854 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4855 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4856 false, kVUIDUndefined, "vkCreateImageView()",
4857 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4858 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004859 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004860 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004861 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004862 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004863 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004864 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004865
4866 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4867 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004868 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004869 VkFormat view_format = pCreateInfo->format;
4870 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004871 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004872 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004873
Dave Houltonbd2e2622018-04-10 16:41:14 -06004874 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004875 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004876 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004877 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004878 if (!device_extensions.vk_ext_separate_stencil_usage) {
4879 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004880 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4881 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4882 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004883 }
4884 } else {
4885 const auto image_stencil_struct =
4886 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4887 if (image_stencil_struct == nullptr) {
4888 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004889 skip |= LogError(
4890 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004891 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4892 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4893 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4894 }
4895 } else {
4896 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4897 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4898 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004899 skip |= LogError(
4900 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004901 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4902 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4903 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4904 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4905 }
4906 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4907 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004908 skip |= LogError(
4909 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004910 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4911 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4912 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4913 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4914 }
4915 }
4916 }
4917 }
4918
Dave Houltonbd2e2622018-04-10 16:41:14 -06004919 image_usage = chained_ivuci_struct->usage;
4920 }
4921
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004922 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4923 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004924 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004925 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004926 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004927 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004928 std::stringstream ss;
4929 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004930 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004931 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004932 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004933 }
4934 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004935 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06004936 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4937 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004938 const char *error_vuid;
4939 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4940 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4941 } else if ((device_extensions.vk_khr_maintenance2) &&
4942 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4943 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4944 } else if ((!device_extensions.vk_khr_maintenance2) &&
4945 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4946 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4947 } else {
4948 // both enabled
4949 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4950 }
Dave Houltonc7988072018-04-16 11:46:56 -06004951 std::stringstream ss;
4952 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004953 << " is not in the same format compatibility class as "
4954 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004955 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4956 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004957 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004958 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004959 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004960 }
4961 } else {
4962 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004963 // Unless it is a multi-planar color bit aspect
4964 if ((image_format != view_format) &&
4965 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4966 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4967 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004968 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004969 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004970 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004971 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004972 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004973 }
4974 }
4975
4976 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004977 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004978
4979 switch (image_type) {
4980 case VK_IMAGE_TYPE_1D:
4981 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004982 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4983 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4984 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004985 }
4986 break;
4987 case VK_IMAGE_TYPE_2D:
4988 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4989 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4990 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004991 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4992 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4993 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004994 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004995 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4996 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4997 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004998 }
4999 }
5000 break;
5001 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005002 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005003 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5004 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5005 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005006 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005007 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5008 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5009 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005010 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5011 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005012 skip |= LogError(
5013 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5014 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5015 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5016 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5017 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005018 }
5019 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005020 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5021 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5022 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005023 }
5024 }
5025 } else {
5026 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005027 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5028 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5029 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005030 }
5031 }
5032 break;
5033 default:
5034 break;
5035 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005036
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005037 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005038 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005039 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005040 }
5041
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005042 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005043
Jeff Bolz9af91c52018-09-01 21:53:57 -05005044 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5045 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005046 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5047 "vkCreateImageView() If image was created with usage containing "
5048 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
5049 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005050 }
5051 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005052 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5053 "vkCreateImageView() If image was created with usage containing "
5054 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005055 }
5056 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005057
5058 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5059 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5060 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5061 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5062 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5063 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5064 }
5065 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5066 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5067 skip |= LogError(
5068 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5069 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5070 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5071 }
5072 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005073
5074 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5075 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005076 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005077 "vkCreateImageView(): If image was created with usage containing "
5078 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5079 pCreateInfo->subresourceRange.levelCount);
5080 }
5081 }
5082 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5083 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005084 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005085 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5086 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5087 }
5088 } else {
5089 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5090 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5091 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
5092 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02573",
5093 "vkCreateImageView(): If image was created with usage containing "
5094 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5095 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5096 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5097 }
5098 }
5099 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005100 }
5101 return skip;
5102}
5103
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005104bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
5105 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005106 bool skip = false;
5107
5108 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5109 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5110 VkDeviceSize src_min = UINT64_MAX;
5111 VkDeviceSize src_max = 0;
5112 VkDeviceSize dst_min = UINT64_MAX;
5113 VkDeviceSize dst_max = 0;
5114
5115 for (uint32_t i = 0; i < regionCount; i++) {
5116 src_min = std::min(src_min, pRegions[i].srcOffset);
5117 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5118 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5119 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5120
5121 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5122 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005123 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
5124 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
5125 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5126 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005127 }
5128
5129 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5130 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005131 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
5132 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
5133 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5134 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005135 }
5136
5137 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5138 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005139 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
5140 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5141 ") is greater than the source buffer size (%" PRIuLEAST64
5142 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
5143 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005144 }
5145
5146 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5147 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005148 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
5149 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5150 ") is greater than the destination buffer size (%" PRIuLEAST64
5151 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
5152 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005153 }
5154 }
5155
5156 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5157 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5158 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005159 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
5160 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005161 }
5162 }
5163
5164 return skip;
5165}
5166
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005167bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005168 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005169 const auto cb_node = GetCBState(commandBuffer);
5170 const auto src_buffer_state = GetBufferState(srcBuffer);
5171 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005172
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005173 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005174 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5175 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005176 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005177 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005178 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5179 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005180 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005181 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5182 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005183 skip |=
5184 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5185 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005186 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5187 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005188 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005189 return skip;
5190}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005191
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005192bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005193 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005194 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005195 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005196 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
5197 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005198 } else {
5199 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005200 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5201 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005202 }
5203 }
5204 return skip;
5205}
5206
Jeff Bolz5c801d12019-10-09 10:38:45 -05005207bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5208 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005209 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005210 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005211
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005212 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005213 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005214 skip |=
5215 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005216 }
5217 return skip;
5218}
5219
Jeff Bolz5c801d12019-10-09 10:38:45 -05005220bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005221 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005222
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005223 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005224 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005225 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005226 }
5227 return skip;
5228}
5229
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005230bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005231 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005232 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005233 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005234 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005235 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005236 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005237 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005238 }
5239 return skip;
5240}
5241
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005242bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005243 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005244 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005245 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005246 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005247 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005248 skip |=
5249 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5250 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005251 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005252 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005253 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5254 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005255 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005256
5257 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005258 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5259 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5260 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5261 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005262 }
5263
5264 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005265 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5266 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5267 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5268 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005269 }
5270
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005271 return skip;
5272}
5273
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005274bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
5275 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005276 bool skip = false;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005277 assert(image_state != nullptr);
5278 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005279
5280 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005281 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005282 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5283 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005284 skip |=
5285 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
5286 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5287 "and 1, respectively.",
5288 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005289 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005290 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005291
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005292 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5293 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005294 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
5295 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
5296 "must be 0 and 1, respectively.",
5297 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005298 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005299 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005300
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005301 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5302 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005303 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
5304 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5305 "For 3D images these must be 0 and 1, respectively.",
5306 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005307 }
5308 }
5309
5310 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005311 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005312 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005313
sfricke-samsung125d2b42020-05-28 06:32:43 -07005314 // If not depth/stencil and not multi-plane
5315 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5316 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
5317 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-bufferOffset-01558"
5318 : "VUID-VkBufferImageCopy-bufferOffset-00193";
5319 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005320 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5321 " must be a multiple of this format's texel size (%" PRIu32 ").",
5322 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005323 }
5324
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005325 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5326 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005327 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005328 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
5329 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5330 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005331 }
5332
5333 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5334 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005335 skip |= LogError(
5336 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005337 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5338 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005339 }
5340
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005341 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005342 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005343 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005344 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 -06005345 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5346 static_cast<int32_t>(adjusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005347 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
5348 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5349 "zero or <= image subresource width (%d).",
5350 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005351 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005352 }
5353
5354 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005355 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 -06005356 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5357 static_cast<int32_t>(adjusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005358 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
5359 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5360 "zero or <= image subresource height (%d).",
5361 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005362 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005363 }
5364
5365 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005366 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 -06005367 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5368 static_cast<int32_t>(adjusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005369 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
5370 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5371 "zero or <= image subresource depth (%d).",
5372 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005373 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005374 }
5375
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005376 // subresource aspectMask must have exactly 1 bit set
5377 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005378 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005379 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005380 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005381 "%s(): aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005382 }
5383
5384 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005385 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005386 skip |= LogError(
5387 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005388 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
sfricke-samsung125d2b42020-05-28 06:32:43 -07005389 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005390 }
5391
5392 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005393 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5394 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005395
5396 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005397 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005398 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5399 ? "VUID-VkBufferImageCopy-None-01735"
5400 : "VUID-VkBufferImageCopy-bufferRowLength-00203";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005401 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005402 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005403 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5404 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005405 }
5406
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005407 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005408 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005409 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5410 ? "VUID-VkBufferImageCopy-None-01736"
5411 : "VUID-VkBufferImageCopy-bufferImageHeight-00204";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005412 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005413 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005414 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5415 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005416 }
5417
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005418 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005419 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5420 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5421 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005422 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01737"
5423 : "VUID-VkBufferImageCopy-imageOffset-00205";
5424 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005425 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5426 "width & height (%d, %d)..",
5427 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5428 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005429 }
5430
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005431 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005432 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005433 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005434 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5435 ? "VUID-VkBufferImageCopy-None-01738"
5436 : "VUID-VkBufferImageCopy-bufferOffset-00206";
5437 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005438 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5439 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5440 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005441 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005442
5443 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005444 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005445 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005446 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005447 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01739"
5448 : "VUID-VkBufferImageCopy-imageExtent-00207";
5449 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005450 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5451 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5452 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5453 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005454 }
5455
5456 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005457 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005458 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005459 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01740"
5460 : "VUID-VkBufferImageCopy-imageExtent-00208";
5461 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005462 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5463 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5464 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5465 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005466 }
5467
5468 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005469 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005470 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005471 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01741"
5472 : "VUID-VkBufferImageCopy-imageExtent-00209";
5473 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005474 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5475 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5476 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5477 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005478 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005479 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005480
5481 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005482 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005483 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005484 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005485 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5486 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5487 "format has three planes.",
5488 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005489 }
5490
5491 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005492 if (0 ==
5493 (region_aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005494 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5495 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5496 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5497 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005498 } else {
5499 // Know aspect mask is valid
5500 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5501 const uint32_t compatible_size = FormatElementSize(compatible_format);
5502 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5503 skip |= LogError(
5504 image_state->image, "VUID-VkBufferImageCopy-bufferOffset-01559",
5505 "%s(): pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
5506 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5507 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5508 string_VkFormat(compatible_format));
5509 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005510 }
5511 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005512 }
5513
5514 return skip;
5515}
5516
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005517bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5518 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005519 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005520 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005521
5522 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005523 VkExtent3D extent = pRegions[i].imageExtent;
5524 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005525
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005526 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5527 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005528 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5529 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5530 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005531 }
5532
5533 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5534
5535 // 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 -06005536 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005537 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005538 if (image_extent.width % block_extent.width) {
5539 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5540 }
5541 if (image_extent.height % block_extent.height) {
5542 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5543 }
5544 if (image_extent.depth % block_extent.depth) {
5545 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5546 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005547 }
5548
Dave Houltonfc1a4052017-04-27 14:32:45 -06005549 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005550 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005551 }
5552 }
5553
5554 return skip;
5555}
5556
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005557bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5558 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005559 bool skip = false;
5560
5561 VkDeviceSize buffer_size = buff_state->createInfo.size;
5562
5563 for (uint32_t i = 0; i < regionCount; i++) {
5564 VkExtent3D copy_extent = pRegions[i].imageExtent;
5565
5566 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5567 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005568 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5569 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005570
Tom Cooperb2550c72018-10-15 13:08:41 +01005571 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005572 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005573 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005574 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5575 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5576
5577 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5578 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5579 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005580 }
5581
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005582 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5583 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5584 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005585 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005586 } else {
5587 // Calculate buffer offset of final copied byte, + 1.
5588 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5589 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5590 max_buffer_offset *= unit_size; // convert to bytes
5591 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005592
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005593 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005594 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5595 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005596 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005597 }
5598 }
5599
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005600 return skip;
5601}
5602
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005603bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005604 VkBuffer dstBuffer, uint32_t regionCount,
5605 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005606 const auto cb_node = GetCBState(commandBuffer);
5607 const auto src_image_state = GetImageState(srcImage);
5608 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005609
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005610 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005611
5612 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005613 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005614
5615 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005616 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005617
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005618 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005619
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005620 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005621 skip |=
5622 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5623 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5624 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005625 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005626 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005627 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005628 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005629 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005630
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005631 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005632 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005633 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5634 skip |=
5635 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005636
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005637 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005638 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005639 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5640 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005641 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005642 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5643 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005644
5645 // Validation for VK_EXT_fragment_density_map
5646 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5647 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyImageToBuffer-srcImage-02544",
5648 "vkCmdCopyBufferToImage(): srcImage must not have been created with flags containing "
5649 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5650 }
5651
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005652 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005653 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005654 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005655 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005656 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005657 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005658 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5659 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5660 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005661 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005662 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005663 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005664 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005665 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5666 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005667 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5668 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5669 skip |=
5670 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5671 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5672 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005673 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5674 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005675 }
5676 return skip;
5677}
5678
John Zulauf1686f232019-07-09 16:27:11 -06005679void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5680 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5681 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5682
5683 auto cb_node = GetCBState(commandBuffer);
5684 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005685 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005686 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005687 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005688 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005689}
5690
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005691bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5692 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005693 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005694 const auto cb_node = GetCBState(commandBuffer);
5695 const auto src_buffer_state = GetBufferState(srcBuffer);
5696 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005697
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005698 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005699
5700 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005701 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005702
5703 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005704 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005705 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005706 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005707 skip |=
5708 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5709 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5710 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005711 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005712 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005713 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005714 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005715 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005716 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005717 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005718 skip |=
5719 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5720 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005721 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005722 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5723 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005724 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005725 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5726 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005727
5728 // Validation for VK_EXT_fragment_density_map
5729 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5730 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyBufferToImage-dstImage-02543",
5731 "vkCmdCopyBufferToImage(): dstImage must not have been created with flags containing "
5732 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5733 }
5734
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005735 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005736 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005737 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005738 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005739 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005740 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005741 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5742 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5743 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005744 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005745 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005746 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005747 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005748 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5749 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005750 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5751 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5752 skip |=
5753 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5754 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5755 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005756 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5757 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005758 }
5759 return skip;
5760}
5761
John Zulauf1686f232019-07-09 16:27:11 -06005762void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5763 VkImageLayout dstImageLayout, uint32_t regionCount,
5764 const VkBufferImageCopy *pRegions) {
5765 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5766
5767 auto cb_node = GetCBState(commandBuffer);
5768 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005769 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005770 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005771 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005772 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005773}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005774
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005775bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005776 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005777 bool skip = false;
5778 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5779
Dave Houlton1d960ff2018-01-19 12:17:05 -07005780 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005781 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5782 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5783 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005784 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5785 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005786 }
5787
John Zulaufa26d3c82019-08-14 16:09:08 -06005788 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005789 if (!image_entry) {
5790 return skip;
5791 }
5792
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005793 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5794 if (device_extensions.vk_ext_image_drm_format_modifier) {
5795 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5796 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005797 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5798 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5799 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005800 }
5801 } else {
5802 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005803 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5804 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005805 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005806 }
5807
Dave Houlton1d960ff2018-01-19 12:17:05 -07005808 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005809 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005810 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5811 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5812 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005813 }
5814
Dave Houlton1d960ff2018-01-19 12:17:05 -07005815 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005816 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005817 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5818 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5819 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005820 }
5821
Dave Houlton1d960ff2018-01-19 12:17:05 -07005822 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005823 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005824 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5825 if (FormatIsMultiplane(img_format)) {
5826 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5827 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5828 if (FormatPlaneCount(img_format) > 2u) {
5829 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5830 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5831 }
5832 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005833 skip |= LogError(image, vuid,
5834 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5835 ") must be a single-plane specifier flag.",
5836 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005837 }
5838 } else if (FormatIsColor(img_format)) {
5839 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005840 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5841 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5842 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005843 }
5844 } else if (FormatIsDepthOrStencil(img_format)) {
5845 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5846 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005847 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005848 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5849 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5850 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5851 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005852 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5853 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5854 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005855 }
5856 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005857
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005858 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005859 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005860 }
5861
Mike Weiblen672b58b2017-02-21 14:32:53 -07005862 return skip;
5863}