blob: c305861e7e759fa9fe04b002d256292a3c9e9162 [file] [log] [blame]
sfricke-samsung552d5e12020-01-07 22:00:20 -08001/* Copyright (c) 2015-2020 The Khronos Group Inc.
2 * Copyright (c) 2015-2020 Valve Corporation
3 * Copyright (c) 2015-2020 LunarG, Inc.
4 * Copyright (C) 2015-2020 Google Inc.
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07005 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060019 * Author: Dave Houlton <daveh@lunarg.com>
Shannon McPherson3ea65132018-12-05 10:37:39 -070020 * Shannon McPherson <shannon@lunarg.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070021 */
22
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060023#include <cmath>
24#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070025#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020026#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070027
28#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020029#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030#include "vk_layer_data.h"
31#include "vk_layer_utils.h"
32#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060033#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070034
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070035#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070036#include "core_validation.h"
37#include "shader_validation.h"
38#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070039#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070040
John Zulauff660ad62019-03-23 07:16:05 -060041// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
42static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
43 VkImageSubresourceRange subresource_range;
44 subresource_range.aspectMask = subresource_layers.aspectMask;
45 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
46 subresource_range.layerCount = subresource_layers.layerCount;
47 subresource_range.baseMipLevel = subresource_layers.mipLevel;
48 subresource_range.levelCount = 1;
49 return subresource_range;
50}
51
John Zulaufb58415b2019-12-09 15:02:32 -070052static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
53 const VkImageSubresourceRange &range);
54static VkImageSubresourceRange MakeImageFullRange(const VkImageCreateInfo &create_info) {
55 const auto format = create_info.format;
56 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
57 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
58 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
59 } else {
60 init_range.aspectMask =
61 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
62 }
63 return NormalizeSubresourceRange(create_info, init_range);
64}
65
John Zulauff660ad62019-03-23 07:16:05 -060066IMAGE_STATE::IMAGE_STATE(VkImage img, const VkImageCreateInfo *pCreateInfo)
67 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -070068 safe_create_info(pCreateInfo),
69 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -060070 valid(false),
71 acquired(false),
72 shared_presentable(false),
73 layout_locked(false),
74 get_sparse_reqs_called(false),
75 sparse_metadata_required(false),
76 sparse_metadata_bound(false),
77 imported_ahb(false),
78 has_ahb_format(false),
79 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),
unknown08c57af2019-06-21 16:33:35 -060085 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060086 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
87 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
88 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
89 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
90 }
91 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
92 }
93
94 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
95 sparse = true;
96 }
Locked8af3732019-05-10 09:47:56 -060097
sfricke-samsunge2441192019-11-06 14:07:57 -080098 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
99 if (externalMemoryInfo) {
100 external_memory_handle = externalMemoryInfo->handleTypes;
101 }
102
Locked8af3732019-05-10 09:47:56 -0600103#ifdef VK_USE_PLATFORM_ANDROID_KHR
104 auto external_format = lvl_find_in_chain<VkExternalFormatANDROID>(createInfo.pNext);
105 if (external_format) {
106 external_format_android = external_format->externalFormat;
107 } else {
108 // If externalFormat is zero, the effect is as if the VkExternalFormatANDROID structure was not present.
109 external_format_android = 0;
110 }
111#endif // VK_USE_PLATFORM_ANDROID_KHR
John Zulauff660ad62019-03-23 07:16:05 -0600112}
113
unknown2c877272019-07-11 12:56:50 -0600114bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
115 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
116 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
117 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
118 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
119 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
120 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
121 return is_equal && IsQueueFamilyIndicesEqual(other_createInfo);
122}
123
Jeff Bolz82f854d2019-09-17 14:56:47 -0500124// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
125bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
126 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
127 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
128 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
129 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
130 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
131 is_compatible = is_compatible && IsQueueFamilyIndicesEqual(other_createInfo) && IsTilingEqual(other_createInfo);
132
133 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
134 createInfo.extent.height <= other_createInfo.extent.height &&
135 createInfo.extent.depth <= other_createInfo.extent.depth &&
136 createInfo.arrayLayers <= other_createInfo.arrayLayers;
137 return is_compatible;
138}
139
unknown2c877272019-07-11 12:56:50 -0600140bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
141 if (!(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT)) return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700142 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
143 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600144 IsCreateInfoEqual(other_image_state->createInfo)) {
145 return true;
146 }
unknowne1661522019-07-11 13:04:18 -0600147 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
148 return true;
149 }
unknown2c877272019-07-11 12:56:50 -0600150 return false;
151}
152
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500153IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
154 : image_view(iv),
155 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700156 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
157 range_generator(im->range_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500158 samplerConversion(VK_NULL_HANDLE),
159 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600160 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
161 if (conversionInfo) samplerConversion = conversionInfo->conversion;
162 if (image_state) {
163 // A light normalization of the createInfo range
164 auto &sub_res_range = create_info.subresourceRange;
165 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
166 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
167
168 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700169 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500170 samples = image_state->createInfo.samples;
171 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600172 }
173}
174
Dave Houltond9611312018-11-19 17:03:36 -0700175uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
176 // uint cast applies floor()
177 return 1u + (uint32_t)log2(std::max({height, width, depth}));
178}
179
180uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
181
182uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
183
John Zulaufb58415b2019-12-09 15:02:32 -0700184static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
185 const VkImageSubresourceRange &range) {
John Zulauff660ad62019-03-23 07:16:05 -0600186 VkImageSubresourceRange norm = range;
187 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
188
189 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
190 // <arrayLayers> can potentially alias.
191 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
192 ? image_create_info.extent.depth
193 : image_create_info.arrayLayers;
194 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
195
196 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
197 VkImageAspectFlags &aspect_mask = norm.aspectMask;
198 if (FormatIsMultiplane(image_create_info.format)) {
199 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
200 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
201 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
202 if (FormatPlaneCount(image_create_info.format) > 2) {
203 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
204 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700205 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700206 }
John Zulauff660ad62019-03-23 07:16:05 -0600207 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700208}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700209
John Zulaufb58415b2019-12-09 15:02:32 -0700210VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
211 const VkImageCreateInfo &image_create_info = image_state.createInfo;
212 return NormalizeSubresourceRange(image_create_info, range);
213}
214
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700215template <class OBJECT, class LAYOUT>
locke-lunarga344e7c2020-01-02 19:48:53 -0700216void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, const VkImageSubresource &subresource, const LAYOUT &layout) {
217 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_COLOR_BIT);
218 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
219 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
220 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600221 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
locke-lunarga344e7c2020-01-02 19:48:53 -0700222 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
223 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
224 SetLayout(pObject, image, subresource, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700225 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700226}
227
228template <class OBJECT, class LAYOUT>
locke-lunarga344e7c2020-01-02 19:48:53 -0700229void CoreChecks::SetLayout(OBJECT *pObject, const VkImage image, VkImageSubresource subresource, const LAYOUT &layout,
230 VkImageAspectFlags aspectMask) {
231 if (subresource.aspectMask & aspectMask) {
232 subresource.aspectMask = aspectMask;
233 SetLayout(pObject, image, subresource, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700234 }
235}
236
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500237bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700238 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700239 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700240
John Zulauf2076e812020-01-08 14:55:54 -0700241 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
242 if (!layout_range_map) return false;
243 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
244
245 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
246 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700247 return false;
248 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700249
John Zulauf2076e812020-01-08 14:55:54 -0700250 for (auto entry : *layout_range_map) {
251 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700252 }
253 return true;
254}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700255
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600256// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600257void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600258 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
259 VkImageLayout expected_layout) {
260 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
261 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600262 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600263 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700264 }
265}
John Zulauff660ad62019-03-23 07:16:05 -0600266
267// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600268void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500269 if (disabled.image_layout_validation) {
270 return;
271 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500272 IMAGE_STATE *image_state = view_state.image_state.get();
273 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700274 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600275}
276
277// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600278void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600279 const VkImageSubresourceRange &range, VkImageLayout layout) {
280 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
281 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600282 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600283}
284
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600285void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600286 VkImageLayout layout) {
287 const IMAGE_STATE *image_state = GetImageState(image);
288 if (!image_state) return;
289 SetImageInitialLayout(cb_node, *image_state, range, layout);
290};
291
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600292void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600293 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
294 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600295}
Dave Houltonddd65c52018-05-08 14:58:01 -0600296
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600297// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700298void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
299 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500300 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600301
John Zulauff660ad62019-03-23 07:16:05 -0600302 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600303 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
304 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600305 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 -0600306 sub_range.baseArrayLayer = 0;
307 sub_range.layerCount = image_state->createInfo.extent.depth;
308 }
309
Piers Daniell4fde9b72019-11-27 16:19:46 -0700310 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
311 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
312 SetImageLayout(cb_node, *image_state, sub_range, layout);
313 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
314 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
315 } else {
316 SetImageLayout(cb_node, *image_state, sub_range, layout);
317 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600318}
319
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700320bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
321 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700322 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600323 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100324 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700325 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100326 const char *vuid;
327 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
328
329 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700330 skip |= LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
331 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
332 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
333 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100334 return skip;
335 }
336
337 auto image_usage = image_state->createInfo.usage;
338
339 // Check for layouts that mismatch image usages in the framebuffer
340 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800341 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100342 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700343 LogError(image, vuid,
344 "Layout/usage mismatch for attachment %u in %s"
345 " - the %s is %s but the image attached to %s via %s"
346 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
347 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
348 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100349 }
350
351 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
352 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800353 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100354 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700355 LogError(image, vuid,
356 "Layout/usage mismatch for attachment %u in %s"
357 " - the %s is %s but the image attached to %s via %s"
358 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
359 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
360 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100361 }
362
363 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800364 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100365 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700366 LogError(image, vuid,
367 "Layout/usage mismatch for attachment %u in %s"
368 " - the %s is %s but the image attached to %s via %s"
369 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
370 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
371 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100372 }
373
374 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800375 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100376 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700377 LogError(image, vuid,
378 "Layout/usage mismatch for attachment %u in %s"
379 " - the %s is %s but the image attached to %s via %s"
380 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
381 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
382 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100383 }
384
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600385 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100386 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
387 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
388 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
389 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
390 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800391 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700392 skip |= LogError(image, vuid,
393 "Layout/usage mismatch for attachment %u in %s"
394 " - the %s is %s but the image attached to %s via %s"
395 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
396 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
397 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
398 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100399 }
400 } else {
401 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
402 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
403 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
404 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700405 skip |= LogError(image, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
406 "Layout/usage mismatch for attachment %u in %s"
407 " - the %s is %s but the image attached to %s via %s"
408 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
409 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
410 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
411 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100412 }
413 }
414 return skip;
415}
416
John Zulauf17a01bb2019-08-09 16:41:19 -0600417bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700418 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600419 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600420 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700421 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700422 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100423 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100424
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700425 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100426 auto framebuffer = framebuffer_state->framebuffer;
427
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700428 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700429 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
430 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700431 }
John Zulauf8e308292018-09-21 11:34:37 -0600432
Tobias Hectorc9057422019-07-23 12:15:52 +0100433 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
434 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
435 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100436 }
437
Tobias Hectorc9057422019-07-23 12:15:52 +0100438 if (attachments != nullptr) {
439 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
440 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
441 auto image_view = attachments[i];
442 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100443
Tobias Hectorc9057422019-07-23 12:15:52 +0100444 if (!view_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700445 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
446 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
447 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
448 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100449 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100450 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100451
452 const VkImage image = view_state->create_info.image;
453 const IMAGE_STATE *image_state = GetImageState(image);
454
455 if (!image_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700456 skip |= LogError(pRenderPassBegin->renderPass, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
457 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
458 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
459 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100460 continue;
461 }
462 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
463 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
464
Piers Daniell7f894f62020-01-09 16:33:48 -0700465 // Default to expecting stencil in the same layout.
466 auto attachment_stencil_initial_layout = attachment_initial_layout;
467
468 // If a separate layout is specified, look for that.
469 const auto *attachment_description_stencil_layout =
470 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
471 if (attachment_description_stencil_layout) {
472 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
473 }
474
Tobias Hectorc9057422019-07-23 12:15:52 +0100475 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
476 // in common with the non-const version.)
477 const ImageSubresourceLayoutMap *subresource_map =
478 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
479
480 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
481 LayoutUseCheckAndMessage layout_check(subresource_map);
482 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700483 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
484 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
485 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700486
John Zulauf5e617452019-11-19 14:44:16 -0700487 // Allow for differing depth and stencil layouts
488 VkImageLayout check_layout = attachment_initial_layout;
489 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
490
491 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700492 subres_skip |= LogError(
493 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700494 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
495 "and the %s layout of the attachment is %s. The layouts must match, or the render "
496 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700497 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100498 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700499 }
John Zulauf5e617452019-11-19 14:44:16 -0700500
Tobias Hectorc9057422019-07-23 12:15:52 +0100501 skip |= subres_skip;
502 }
503
504 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
505 framebuffer, render_pass, i, "initial layout");
506
507 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
508 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100509 }
510
Tobias Hectorc9057422019-07-23 12:15:52 +0100511 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
512 auto &subpass = pRenderPassInfo->pSubpasses[j];
513 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
514 auto &attachment_ref = subpass.pInputAttachments[k];
515 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
516 auto image_view = attachments[attachment_ref.attachment];
517 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100518
Tobias Hectorc9057422019-07-23 12:15:52 +0100519 if (view_state) {
520 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700521 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
522 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100523 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100524 }
525 }
526 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100527
Tobias Hectorc9057422019-07-23 12:15:52 +0100528 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
529 auto &attachment_ref = subpass.pColorAttachments[k];
530 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
531 auto image_view = attachments[attachment_ref.attachment];
532 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100533
Tobias Hectorc9057422019-07-23 12:15:52 +0100534 if (view_state) {
535 auto image = view_state->create_info.image;
536 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
537 framebuffer, render_pass, attachment_ref.attachment,
538 "color attachment layout");
539 if (subpass.pResolveAttachments) {
540 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
541 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
542 attachment_ref.attachment, "resolve attachment layout");
543 }
544 }
545 }
546 }
547
548 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
549 auto &attachment_ref = *subpass.pDepthStencilAttachment;
550 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
551 auto image_view = attachments[attachment_ref.attachment];
552 auto view_state = GetImageViewState(image_view);
553
554 if (view_state) {
555 auto image = view_state->create_info.image;
556 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
557 framebuffer, render_pass, attachment_ref.attachment,
558 "input attachment layout");
559 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100560 }
561 }
562 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700563 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600564 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700565}
566
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600567void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700568 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700569 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700570 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600571 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700572 VkImageLayout stencil_layout = kInvalidLayout;
573 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
574 if (attachment_reference_stencil_layout) {
575 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
576 }
577
578 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600579 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700580 }
581}
582
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600583void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
584 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700585 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700586
587 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700588 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700589 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700590 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700591 }
592 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700593 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700594 }
595 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700596 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700597 }
598 }
599}
600
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700601// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
602// 1. Transition into initialLayout state
603// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600604void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700605 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700606 // First transition into initialLayout
607 auto const rpci = render_pass_state->createInfo.ptr();
608 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700609 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600610 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700611 VkImageLayout stencil_layout = kInvalidLayout;
612 const auto *attachment_description_stencil_layout =
613 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
614 if (attachment_description_stencil_layout) {
615 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
616 }
617
618 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600619 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700620 }
621 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700622 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700623}
624
Dave Houlton10b39482017-03-16 13:18:15 -0600625bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600626 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600627 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600628 }
629 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600630 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600631 }
632 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600633 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600634 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700635 if (0 !=
636 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
637 if (FormatPlaneCount(format) == 1) return false;
638 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600639 return true;
640}
641
Mike Weiblen62d08a32017-03-07 22:18:27 -0700642// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200643bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
644 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600645 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700646 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200647 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600648 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700649
650 switch (layout) {
651 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
652 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600653 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700654 }
655 break;
656 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
657 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600658 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700659 }
660 break;
661 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
662 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600663 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700664 }
665 break;
666 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
667 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600668 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700669 }
670 break;
671 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
672 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600673 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700674 }
675 break;
676 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
677 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600678 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700679 }
680 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600681 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500682 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
683 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
684 }
685 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700686 default:
687 // Other VkImageLayout values do not have VUs defined in this context.
688 break;
689 }
690
Dave Houlton8e9f6542018-05-18 12:18:22 -0600691 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700692 skip |= LogError(img_barrier.image, msg_code,
693 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
694 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
695 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700696 }
697 return skip;
698}
699
700// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600701bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
702 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700703 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700704
Petr Krausad0096a2019-08-09 18:35:04 +0200705 // Scoreboard for checking for duplicate and inconsistent barriers to images
706 struct ImageBarrierScoreboardEntry {
707 uint32_t index;
708 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
709 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
710 const VkImageMemoryBarrier *barrier;
711 };
712 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
713 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
714
John Zulauf463c51e2018-05-31 13:29:20 -0600715 // Scoreboard for duplicate layout transition barriers within the list
716 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
717 ImageBarrierScoreboardImageMap layout_transitions;
718
Mike Weiblen62d08a32017-03-07 22:18:27 -0700719 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200720 const auto &img_barrier = pImageMemoryBarriers[i];
721 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700722
John Zulauf463c51e2018-05-31 13:29:20 -0600723 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
724 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
725 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200726 if (img_barrier.oldLayout != img_barrier.newLayout) {
727 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
728 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600729 if (image_it != layout_transitions.end()) {
730 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200731 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600732 if (subres_it != subres_map.end()) {
733 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200734 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
735 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
736 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700737 skip = LogError(
738 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200739 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600740 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
741 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200742 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
743 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
744 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600745 }
746 entry = new_entry;
747 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200748 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600749 }
750 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200751 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600752 }
753 }
754
Petr Krausad0096a2019-08-09 18:35:04 +0200755 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600756 if (image_state) {
757 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200758 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
759 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600760
761 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
762 if (image_state->layout_locked) {
763 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700764 skip |= LogError(
765 img_barrier.image, 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600766 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600767 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Petr Krausad0096a2019-08-09 18:35:04 +0200768 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
769 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600770 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600771
John Zulaufa4472282019-08-22 14:44:34 -0600772 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600773 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600774 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200775 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700776 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600777 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
778 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700779 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
780 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
781 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
782 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
783 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600784 }
785 } else {
786 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
787 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700788 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03320",
789 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
790 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
791 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
792 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600793 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700794 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700795 }
John Zulauff660ad62019-03-23 07:16:05 -0600796
Petr Krausad0096a2019-08-09 18:35:04 +0200797 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
798 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600799 // TODO: Set memory invalid which is in mem_tracker currently
800 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
801 // subresource.
802 } else if (subresource_map) {
803 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600804 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200805 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700806 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
807 const auto &value = *pos;
808 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700809 subres_skip = LogError(
810 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
John Zulauf5e617452019-11-19 14:44:16 -0700811 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
812 "%s layout is %s.",
813 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
814 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
815 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600816 }
John Zulauf5e617452019-11-19 14:44:16 -0700817 }
John Zulauff660ad62019-03-23 07:16:05 -0600818 skip |= subres_skip;
819 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700820 }
821 }
822 return skip;
823}
824
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600825bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200826 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700827
Jeff Bolz6835fda2019-10-06 00:15:34 -0500828 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200829 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700830}
831
John Zulauf6b4aae82018-05-09 13:03:36 -0600832template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600833bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
834 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600835 using BarrierRecord = QFOTransferBarrier<Barrier>;
836 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500837 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600838 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
839 const char *barrier_name = BarrierRecord::BarrierName();
840 const char *handle_name = BarrierRecord::HandleName();
841 const char *transfer_type = nullptr;
842 for (uint32_t b = 0; b < barrier_count; b++) {
843 if (!IsTransferOp(&barriers[b])) continue;
844 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700845 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600846 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600847 const auto found = barrier_sets.release.find(barriers[b]);
848 if (found != barrier_sets.release.cend()) {
849 barrier_record = &(*found);
850 transfer_type = "releasing";
851 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600852 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600853 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600854 const auto found = barrier_sets.acquire.find(barriers[b]);
855 if (found != barrier_sets.acquire.cend()) {
856 barrier_record = &(*found);
857 transfer_type = "acquiring";
858 }
859 }
860 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700861 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
862 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
863 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
864 func_name, barrier_name, b, transfer_type, handle_name,
865 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
866 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600867 }
868 }
869 return skip;
870}
871
John Zulaufa4472282019-08-22 14:44:34 -0600872VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
873 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
874}
875
876const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
877 return device_state.GetImageState(barrier.image);
878}
879
880VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
881 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
882}
883
884const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
885 return device_state.GetBufferState(barrier.buffer);
886}
887
888VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
889
John Zulauf6b4aae82018-05-09 13:03:36 -0600890template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600891void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
892 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500893 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600894 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
895 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600896 auto &barrier = barriers[b];
897 if (IsTransferOp(&barrier)) {
898 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
899 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
900 barrier_sets.release.emplace(barrier);
901 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
902 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
903 barrier_sets.acquire.emplace(barrier);
904 }
905 }
906
907 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
908 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
909 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
910 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
911 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
912 auto handle_state = BarrierHandleState(*this, barrier);
913 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
914 if (!mode_concurrent) {
915 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -0500916 cb_state->queue_submit_functions.emplace_back(
917 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
918 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
919 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
920 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -0600921 });
922 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600923 }
924 }
925}
926
John Zulaufa4472282019-08-22 14:44:34 -0600927bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600928 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700929 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -0600930 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600931 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700932 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
933 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600934 return skip;
935}
936
John Zulaufa4472282019-08-22 14:44:34 -0600937void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
938 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
939 const VkImageMemoryBarrier *pImageMemBarriers) {
940 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
941 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600942}
943
944template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600945bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600946 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600947 // Record to the scoreboard or report that we have a duplication
948 bool skip = false;
949 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
950 if (!inserted.second && inserted.first->second != cb_state) {
951 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700952 skip = LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
953 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
954 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
955 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
956 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
957 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600958 }
959 return skip;
960}
961
962template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -0600963bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
964 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600965 using BarrierRecord = QFOTransferBarrier<Barrier>;
966 using TypeTag = typename BarrierRecord::Tag;
967 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600968 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700969 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600970 const char *barrier_name = BarrierRecord::BarrierName();
971 const char *handle_name = BarrierRecord::HandleName();
972 // No release should have an extant duplicate (WARNING)
973 for (const auto &release : cb_barriers.release) {
974 // Check the global pending release barriers
975 const auto set_it = global_release_barriers.find(release.handle);
976 if (set_it != global_release_barriers.cend()) {
977 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
978 const auto found = set_for_handle.find(release);
979 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700980 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
981 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
982 " to dstQueueFamilyIndex %" PRIu32
983 " duplicates existing barrier queued for execution, without intervening acquire operation.",
984 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
985 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600986 }
987 }
988 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
989 }
990 // Each acquire must have a matching release (ERROR)
991 for (const auto &acquire : cb_barriers.acquire) {
992 const auto set_it = global_release_barriers.find(acquire.handle);
993 bool matching_release_found = false;
994 if (set_it != global_release_barriers.cend()) {
995 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
996 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
997 }
998 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700999 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1000 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1001 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1002 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1003 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001004 }
1005 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1006 }
1007 return skip;
1008}
1009
John Zulauf3b04ebd2019-07-18 14:08:11 -06001010bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001011 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001012 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001013 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001014 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1015 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001016 return skip;
1017}
1018
1019template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001020void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001021 using BarrierRecord = QFOTransferBarrier<Barrier>;
1022 using TypeTag = typename BarrierRecord::Tag;
1023 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001024 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001025
1026 // Add release barriers from this submit to the global map
1027 for (const auto &release : cb_barriers.release) {
1028 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1029 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1030 global_release_barriers[release.handle].insert(release);
1031 }
1032
1033 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1034 for (const auto &acquire : cb_barriers.acquire) {
1035 // NOTE: We're not using [] because we don't want to create entries for missing releases
1036 auto set_it = global_release_barriers.find(acquire.handle);
1037 if (set_it != global_release_barriers.end()) {
1038 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1039 set_for_handle.erase(acquire);
1040 if (set_for_handle.size() == 0) { // Clean up empty sets
1041 global_release_barriers.erase(set_it);
1042 }
1043 }
1044 }
1045}
1046
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001047void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001048 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1049 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001050}
1051
John Zulauf6b4aae82018-05-09 13:03:36 -06001052// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001053void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001054
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001055void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001056 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001057 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001058 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001059
Chris Forbes4de4b132017-08-21 11:27:08 -07001060 // For ownership transfers, the barrier is specified twice; as a release
1061 // operation on the yielding queue family, and as an acquire operation
1062 // on the acquiring queue family. This barrier may also include a layout
1063 // transition, which occurs 'between' the two operations. For validation
1064 // purposes it doesn't seem important which side performs the layout
1065 // transition, but it must not be performed twice. We'll arbitrarily
1066 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001067 //
1068 // However, we still need to record initial layout for the "initial layout" validation
1069 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001070
Petr Krausad0096a2019-08-09 18:35:04 +02001071 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001072 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001073 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
unknown86bcb3a2019-07-11 13:05:36 -06001074 for (const auto &image : image_state->aliasing_images) {
1075 image_state = GetImageState(image);
John Zulauf2be3fe02019-12-30 09:48:02 -07001076 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001077 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001078 }
1079}
1080
unknown86bcb3a2019-07-11 13:05:36 -06001081void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001082 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001083 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1084 const auto &image_create_info = image_state->createInfo;
1085
1086 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1087 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1088 // for all (potential) layer sub_resources.
1089 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1090 normalized_isr.baseArrayLayer = 0;
1091 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1092 }
1093
John Zulauf2be3fe02019-12-30 09:48:02 -07001094 if (is_release_op) {
1095 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1096 } else {
1097 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1098 }
unknown86bcb3a2019-07-11 13:05:36 -06001099}
1100
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001101bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1102 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1103 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1104 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001105 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001106 assert(cb_node);
1107 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001108 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001109 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001110
John Zulauff660ad62019-03-23 07:16:05 -06001111 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1112 if (subresource_map) {
1113 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001114 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001115 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1116 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001117 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001118 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1119 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1120 "%s layout %s.",
1121 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1122 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1123 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001124 }
John Zulauf5e617452019-11-19 14:44:16 -07001125 }
John Zulauff660ad62019-03-23 07:16:05 -06001126 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001127 }
John Zulauff660ad62019-03-23 07:16:05 -06001128
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001129 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1130 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1131 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001132 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1133 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001134 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1135 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1136 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001137 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001138 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001139 if (image_state->shared_presentable) {
1140 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001141 skip |= LogError(device, layout_invalid_msg_code,
1142 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1143 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001144 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001145 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001146 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001147 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001148 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1149 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1150 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1151 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001152 }
1153 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001154 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001155}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001156bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001157 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1158 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001159 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001160 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1161 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1162}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001163
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001164void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001165 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001166 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001167 if (!renderPass) return;
1168
Tobias Hectorbbb12282018-10-22 15:17:59 +01001169 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001170 if (framebuffer_state) {
1171 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001172 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001173 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001174 VkImageLayout stencil_layout = kInvalidLayout;
1175 const auto *attachment_description_stencil_layout =
1176 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1177 if (attachment_description_stencil_layout) {
1178 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1179 }
1180
1181 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001182 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001183 }
1184 }
1185}
Dave Houltone19e20d2018-02-02 16:32:41 -07001186
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001187#ifdef VK_USE_PLATFORM_ANDROID_KHR
1188// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1189// This could also move into a seperate core_validation_android.cpp file... ?
1190
1191//
1192// AHB-specific validation within non-AHB APIs
1193//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001194bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001195 bool skip = false;
1196
1197 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1198 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001199 if (0 != ext_fmt_android->externalFormat) {
1200 if (VK_FORMAT_UNDEFINED != create_info->format) {
1201 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001202 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1203 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1204 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001205 }
1206
1207 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001208 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1209 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1210 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001211 }
1212
1213 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001214 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1215 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1216 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001217 }
1218
1219 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001220 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1221 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1222 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001223 }
1224 }
1225
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001226 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001227 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
1228 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
1229 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001230 }
1231 }
1232
Dave Houltond9611312018-11-19 17:03:36 -07001233 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001234 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001235 skip |=
1236 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1237 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1238 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001239 }
1240 }
1241
1242 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1243 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1244 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001245 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001246 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1247 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1248 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1249 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001250 }
1251
1252 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001253 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1254 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1255 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1256 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1257 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001258 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001259 }
1260
1261 return skip;
1262}
1263
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001264bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001265 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001266 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001267
1268 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001269 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001270 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1271 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1272 "format member is %s.",
1273 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001274 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001275
Dave Houltond9611312018-11-19 17:03:36 -07001276 // Chain must include a compatible ycbcr conversion
1277 bool conv_found = false;
1278 uint64_t external_format = 0;
1279 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1280 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001281 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001282 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001283 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001284 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001285 }
Dave Houltond9611312018-11-19 17:03:36 -07001286 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001287 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001288 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
1289 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1290 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
Dave Houltond9611312018-11-19 17:03:36 -07001291 }
1292
1293 // Errors in create_info swizzles
1294 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1295 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1296 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1297 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001298 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1299 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1300 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001301 }
1302 }
Dave Houltond9611312018-11-19 17:03:36 -07001303
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001304 return skip;
1305}
1306
John Zulaufa26d3c82019-08-14 16:09:08 -06001307bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001308 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001309
John Zulaufa26d3c82019-08-14 16:09:08 -06001310 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001311 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001312 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1313 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1314 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1315 "bound to memory.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001316 }
1317 return skip;
1318}
1319
1320#else
1321
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001322bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001323 return false;
1324}
1325
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001326bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001327
John Zulaufa26d3c82019-08-14 16:09:08 -06001328bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001329
1330#endif // VK_USE_PLATFORM_ANDROID_KHR
1331
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001332bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001333 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001334 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001335
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001336 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001337 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001338 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1339 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001340 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1341 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001342 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001343 }
1344
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001345 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1346 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001347 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1348 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1349 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001350 }
1351
1352 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001353 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1354 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1355 "height (%d) and arrayLayers (%d) must be >= 6.",
1356 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001357 }
Dave Houlton130c0212018-01-29 13:39:56 -07001358 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001359
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001360 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001361 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1362 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1363 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001364 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1365 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1366 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001367 }
1368
1369 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001370 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1371 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1372 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001373 }
1374
ByumjinConffx991b6062019-08-14 15:17:53 -07001375 if (device_extensions.vk_ext_fragment_density_map) {
1376 uint32_t ceiling_width =
1377 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1378 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1379 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1380 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001381 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1382 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1383 "ceiling of device "
1384 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1385 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1386 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001387 }
1388
1389 uint32_t ceiling_height =
1390 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1391 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1392 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1393 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001394 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1395 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1396 "ceiling of device "
1397 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1398 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1399 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001400 }
1401 }
1402
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001403 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001404 VkResult result = VK_SUCCESS;
1405 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1406 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1407 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1408 &format_limits);
1409 } else {
1410 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1411 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1412 image_format_info.type = pCreateInfo->imageType;
1413 image_format_info.tiling = pCreateInfo->tiling;
1414 image_format_info.usage = pCreateInfo->usage;
1415 image_format_info.flags = pCreateInfo->flags;
1416 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1417 format_limits = image_format_properties.imageFormatProperties;
1418 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001419
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001420 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001421#ifdef VK_USE_PLATFORM_ANDROID_KHR
1422 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1423#endif // VK_USE_PLATFORM_ANDROID_KHR
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001424 skip |=
1425 LogError(device, kVUIDUndefined, "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1426 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001427 } else {
1428 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1429 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001430 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1431 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1432 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001433 }
Dave Houlton130c0212018-01-29 13:39:56 -07001434
Dave Houltona585d132019-01-18 13:05:42 -07001435 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1436 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1437 (uint64_t)pCreateInfo->samples;
1438 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001439
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001440 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001441 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001442 uint64_t ig_mask = imageGranularity - 1;
1443 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001444
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001445 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001446 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1447 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1448 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1449 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001450 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001451
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001452 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001453 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1454 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1455 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001456 }
1457
1458 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001459 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1460 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1461 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001462 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001463 }
1464
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001465 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001466 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1467 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1468 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1469 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001470 skip |= LogError(device, error_vuid,
1471 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1472 "YCbCr Conversion format, arrayLayers must be 1",
1473 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001474 }
1475
1476 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001477 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1478 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1479 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001480 }
1481
1482 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001483 skip |= LogError(
1484 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001485 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1486 string_VkSampleCountFlagBits(pCreateInfo->samples));
1487 }
1488
1489 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001490 skip |= LogError(
1491 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001492 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1493 string_VkImageType(pCreateInfo->imageType));
1494 }
1495 }
1496
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001497 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001498 skip |=
1499 LogError(device, "VUID-VkImageCreateInfo-flags-01924",
1500 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1501 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001502 }
1503
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001504 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001505 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1506 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1507 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1508 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001509 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001510 LogError(device, kVUIDUndefined,
1511 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1512 "format must be block, ETC or ASTC compressed, but is %s",
1513 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001514 }
1515 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1516 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001517 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001518 LogError(device, kVUIDUndefined,
1519 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1520 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001521 }
1522 }
1523 }
1524
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001525 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001526 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1527 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1528 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001529 }
1530
unknown2c877272019-07-11 12:56:50 -06001531 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1532 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1533 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001534 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1535 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1536 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001537 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001538 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001539}
1540
John Zulauf7eeb6f72019-06-17 11:56:36 -06001541void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1542 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1543 if (VK_SUCCESS != result) return;
1544
1545 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001546 auto image_state = Get<IMAGE_STATE>(*pImage);
1547 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001548}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001549
Jeff Bolz5c801d12019-10-09 10:38:45 -05001550bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001551 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001552 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001553 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001554 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001555 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001556 }
1557 return skip;
1558}
1559
John Zulauf7eeb6f72019-06-17 11:56:36 -06001560void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1561 // Clean up validation specific data
1562 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001563
locke-lunargcba7d5f2019-12-30 16:59:11 -07001564 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001565
1566 // Clean up generic image state
1567 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001568}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001569
John Zulauf07288512019-07-05 11:09:50 -06001570bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001571 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001572
1573 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1574 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001575 skip |= LogError(image_state->image, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001576 }
1577
Dave Houlton1d2022c2017-03-29 11:43:58 -06001578 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001579 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001580 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001581 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001582 char const str[] = "vkCmdClearColorImage called with compressed image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001583 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001584 }
1585
1586 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1587 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001588 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001589 }
1590 return skip;
1591}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001592
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001593uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1594 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1595 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001596 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001597 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001598 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001599 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001600}
1601
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001602uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1603 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1604 uint32_t array_layer_count = range->layerCount;
1605 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1606 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001607 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001608 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001609}
1610
John Zulauf07288512019-07-05 11:09:50 -06001611bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1612 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1613 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001614 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001615 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1616 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001617 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1618 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1619 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001620 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001621
1622 } else {
1623 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1624 if (!device_extensions.vk_khr_shared_presentable_image) {
1625 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001626 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1627 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1628 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001629 }
1630 } else {
1631 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1632 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001633 skip |= LogError(
1634 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001635 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1636 func_name, string_VkImageLayout(dest_image_layout));
1637 }
1638 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001639 }
1640
John Zulauff660ad62019-03-23 07:16:05 -06001641 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001642 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001643 if (subresource_map) {
1644 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001645 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001646 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001647 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1648 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001649 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1650 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1651 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1652 } else {
1653 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001654 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001655 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1656 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1657 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1658 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001659 }
John Zulauf5e617452019-11-19 14:44:16 -07001660 }
John Zulauff660ad62019-03-23 07:16:05 -06001661 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001662 }
1663
1664 return skip;
1665}
1666
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001667bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1668 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001669 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001670 bool skip = false;
1671 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001672 const auto *cb_node = GetCBState(commandBuffer);
1673 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001674 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001675 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001676 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001677 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001678 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001679 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001680 skip |=
1681 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1682 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001683 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001684 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001685 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001686 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001687 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001688 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1689 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001690 }
1691 }
1692 return skip;
1693}
1694
John Zulaufeabb4462019-07-05 14:13:03 -06001695void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1696 const VkClearColorValue *pColor, uint32_t rangeCount,
1697 const VkImageSubresourceRange *pRanges) {
1698 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1699
1700 auto cb_node = GetCBState(commandBuffer);
1701 auto image_state = GetImageState(image);
1702 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001703 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001704 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001705 }
1706 }
1707}
1708
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001709bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1710 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001711 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001712 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001713
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001714 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001715 const auto *cb_node = GetCBState(commandBuffer);
1716 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001717 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001718 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001719 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001720 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001721 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001722 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001723 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001724 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1725 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001726 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001727 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001728 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001729
1730 bool any_include_aspect_depth_bit = false;
1731 bool any_include_aspect_stencil_bit = false;
1732
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001733 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001734 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001735 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001736 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001737 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001738 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1739 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001740 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001741 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1742 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001743 skip |= LogError(commandBuffer, kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001744 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001745 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1746 any_include_aspect_depth_bit = true;
1747 }
1748 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1749 any_include_aspect_stencil_bit = true;
1750 }
1751 }
1752 if (any_include_aspect_stencil_bit) {
1753 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1754 if (image_stencil_struct != nullptr) {
1755 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1756 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001757 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1758 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1759 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1760 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001761 }
1762 } else {
1763 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001764 skip |= LogError(
1765 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05001766 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1767 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1768 "in VkImageCreateInfo::usage used to create image");
1769 }
1770 }
1771 }
1772 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001773 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1774 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1775 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001776 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001777 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001778 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001779 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001780 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001781 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1782 char const str[] =
1783 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1784 "set.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001785 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001786 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001787 }
1788 return skip;
1789}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001790
John Zulaufeabb4462019-07-05 14:13:03 -06001791void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1792 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1793 const VkImageSubresourceRange *pRanges) {
1794 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1795 auto cb_node = GetCBState(commandBuffer);
1796 auto image_state = GetImageState(image);
1797 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001798 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001799 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001800 }
1801 }
1802}
1803
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001804// Returns true if [x, xoffset] and [y, yoffset] overlap
1805static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1806 bool result = false;
1807 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1808 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1809
1810 if (intersection_max > intersection_min) {
1811 result = true;
1812 }
1813 return result;
1814}
1815
Dave Houltonc991cc92018-03-06 11:08:51 -07001816// Returns true if source area of first copy region intersects dest area of second region
1817// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1818static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001819 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001820
Dave Houltonc991cc92018-03-06 11:08:51 -07001821 // Separate planes within a multiplane image cannot intersect
1822 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001823 return result;
1824 }
1825
Dave Houltonc991cc92018-03-06 11:08:51 -07001826 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1827 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1828 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001829 result = true;
1830 switch (type) {
1831 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001832 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001833 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001834 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001835 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001836 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001837 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001838 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001839 break;
1840 default:
1841 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1842 assert(false);
1843 }
1844 }
1845 return result;
1846}
1847
Dave Houltonfc1a4052017-04-27 14:32:45 -06001848// Returns non-zero if offset and extent exceed image extents
1849static const uint32_t x_bit = 1;
1850static const uint32_t y_bit = 2;
1851static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001852static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001853 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001854 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001855 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1856 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001857 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001858 }
1859 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1860 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001861 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001862 }
1863 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1864 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001865 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001866 }
1867 return result;
1868}
1869
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001870// Test if two VkExtent3D structs are equivalent
1871static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1872 bool result = true;
1873 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1874 (extent->depth != other_extent->depth)) {
1875 result = false;
1876 }
1877 return result;
1878}
1879
Dave Houltonee281a52017-12-08 13:51:02 -07001880// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1881// Destination image texel extents must be adjusted by block size for the dest validation checks
1882VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1883 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06001884 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1885 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001886 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001887 adjusted_extent.width /= block_size.width;
1888 adjusted_extent.height /= block_size.height;
1889 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06001890 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1891 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001892 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001893 adjusted_extent.width *= block_size.width;
1894 adjusted_extent.height *= block_size.height;
1895 adjusted_extent.depth *= block_size.depth;
1896 }
1897 return adjusted_extent;
1898}
1899
Dave Houlton6f9059e2017-05-02 17:15:13 -06001900// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001901static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1902 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001903
1904 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001905 if (mip >= img->createInfo.mipLevels) {
1906 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001907 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001908
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001909 // 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 -06001910 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001911
Dave Houltone48cd112019-01-03 17:01:18 -07001912 // If multi-plane, adjust per-plane extent
1913 if (FormatIsMultiplane(img->createInfo.format)) {
1914 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1915 extent.width /= divisors.width;
1916 extent.height /= divisors.height;
1917 }
1918
Jeff Bolzef40fec2018-09-01 22:04:34 -05001919 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1920 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001921 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001922 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1923 } else {
1924 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1925 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1926 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1927 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001928
Dave Houlton6f9059e2017-05-02 17:15:13 -06001929 // Image arrays have an effective z extent that isn't diminished by mip level
1930 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001931 extent.depth = img->createInfo.arrayLayers;
1932 }
1933
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001934 return extent;
1935}
1936
1937// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001938static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001939 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1940}
1941
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001942// Test if the extent argument has any dimensions set to 0.
1943static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1944 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1945}
1946
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001947// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001948VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001949 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1950 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05001951 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001952 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001953 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06001954 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001955 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001956 granularity.width *= block_size.width;
1957 granularity.height *= block_size.height;
1958 }
1959 }
1960 return granularity;
1961}
1962
1963// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1964static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1965 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001966 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1967 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001968 valid = false;
1969 }
1970 return valid;
1971}
1972
1973// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001974bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001975 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001976 bool skip = false;
1977 VkExtent3D offset_extent = {};
1978 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1979 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1980 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001981 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001982 // 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 -07001983 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001984 skip |= LogError(cb_node->commandBuffer, vuid,
1985 "%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 "
1986 "image transfer granularity is (w=0, h=0, d=0).",
1987 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001988 }
1989 } else {
1990 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1991 // integer multiples of the image transfer granularity.
1992 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001993 skip |= LogError(cb_node->commandBuffer, vuid,
1994 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1995 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
1996 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1997 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001998 }
1999 }
2000 return skip;
2001}
2002
2003// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002004bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002005 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002006 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002007 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002008 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002009 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2010 // subresource extent.
2011 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002012 skip |= LogError(cb_node->commandBuffer, vuid,
2013 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2014 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2015 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2016 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002017 }
2018 } else {
2019 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2020 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2021 // subresource extent dimensions.
2022 VkExtent3D offset_extent_sum = {};
2023 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2024 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2025 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002026 bool x_ok = true;
2027 bool y_ok = true;
2028 bool z_ok = true;
2029 switch (image_type) {
2030 case VK_IMAGE_TYPE_3D:
2031 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2032 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002033 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002034 case VK_IMAGE_TYPE_2D:
2035 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2036 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002037 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002038 case VK_IMAGE_TYPE_1D:
2039 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2040 (subresource_extent->width == offset_extent_sum.width));
2041 break;
2042 default:
2043 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2044 assert(false);
2045 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002046 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002047 skip |=
2048 LogError(cb_node->commandBuffer, vuid,
2049 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2050 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2051 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2052 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2053 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2054 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002055 }
2056 }
2057 return skip;
2058}
2059
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002060bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002061 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002062 bool skip = false;
2063 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002064 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2065 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002066 }
2067 return skip;
2068}
2069
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002070bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002071 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002072 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002073 bool skip = false;
2074 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2075 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002076 skip |= LogError(cb_node->commandBuffer, vuid,
2077 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2078 "%u, but provided %s has %u array layers.",
2079 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2080 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002081 }
2082 return skip;
2083}
2084
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002085// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002086bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002087 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002088 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002089 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002090 VkExtent3D granularity = GetScaledItg(cb_node, img);
2091 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002092 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002093 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002094 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002095 return skip;
2096}
2097
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002098// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002099bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002100 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002101 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002102 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002103 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002104 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2105 skip |=
2106 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002107 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002108 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002109 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2110 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002111
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002112 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002113 granularity = GetScaledItg(cb_node, dst_img);
2114 skip |=
2115 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002116 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002117 const VkExtent3D dest_effective_extent =
2118 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002119 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002120 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002121 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002122 return skip;
2123}
2124
Dave Houlton6f9059e2017-05-02 17:15:13 -06002125// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002126bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002127 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002128 bool skip = false;
2129
2130 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002131 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002132
2133 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002134 const VkExtent3D src_copy_extent = region.extent;
2135 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002136 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2137
Dave Houlton6f9059e2017-05-02 17:15:13 -06002138 bool slice_override = false;
2139 uint32_t depth_slices = 0;
2140
2141 // Special case for copying between a 1D/2D array and a 3D image
2142 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2143 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002144 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002145 slice_override = (depth_slices != 1);
2146 } 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 -07002147 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002148 slice_override = (depth_slices != 1);
2149 }
2150
2151 // Do all checks on source image
2152 //
2153 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002154 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002155 skip |=
2156 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2157 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2158 "be 0 and 1, respectively.",
2159 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002160 }
2161 }
2162
Dave Houlton533be9f2018-03-26 17:08:30 -06002163 // VUID-VkImageCopy-srcImage-01785
2164 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 -07002165 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2166 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2167 "these must be 0 and 1, respectively.",
2168 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002169 }
2170
Dave Houlton533be9f2018-03-26 17:08:30 -06002171 // VUID-VkImageCopy-srcImage-01787
2172 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002173 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2174 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2175 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002176 }
2177
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002178 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002179 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002180 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002181 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002182 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2183 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2184 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2185 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002186 }
2187 }
2188 } else { // Pre maint 1
2189 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002190 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002191 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2192 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2193 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2194 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2195 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002196 }
2197 }
2198 }
2199
Dave Houltonc991cc92018-03-06 11:08:51 -07002200 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002201 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002202 if (FormatIsCompressed(src_state->createInfo.format) ||
2203 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002204 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002205 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002206 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2207 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2208 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002209 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002210 skip |= LogError(src_state->image, vuid,
2211 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2212 "texel width & height (%d, %d).",
2213 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002214 }
2215
Dave Houlton94a00372017-12-14 15:08:47 -07002216 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002217 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2218 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002219 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002220 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002221 LogError(src_state->image, vuid,
2222 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2223 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2224 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002225 }
2226
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002227 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002228 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2229 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002230 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002231 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002232 LogError(src_state->image, vuid,
2233 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2234 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2235 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002236 }
2237
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002238 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002239 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2240 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002241 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002242 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002243 LogError(src_state->image, vuid,
2244 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2245 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2246 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002247 }
2248 } // Compressed
2249
2250 // Do all checks on dest image
2251 //
2252 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002253 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002254 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2255 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2256 "these must be 0 and 1, respectively.",
2257 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002258 }
2259 }
2260
Dave Houlton533be9f2018-03-26 17:08:30 -06002261 // VUID-VkImageCopy-dstImage-01786
2262 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 -07002263 skip |=
2264 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2265 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2266 "and 1, respectively.",
2267 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002268 }
2269
2270 // VUID-VkImageCopy-dstImage-01788
2271 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002272 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2273 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2274 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002275 }
2276
2277 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002278 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002279 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2280 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2281 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2282 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002283 }
2284 }
2285 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002286 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002287 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002288 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002289 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002290 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2291 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2292 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2293 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002294 }
2295 }
2296 } else { // Pre maint 1
2297 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002298 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002299 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2300 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2301 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2302 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2303 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002304 }
2305 }
2306 }
2307
Dave Houltonc991cc92018-03-06 11:08:51 -07002308 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2309 if (FormatIsCompressed(dst_state->createInfo.format) ||
2310 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002311 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002312
2313 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002314 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2315 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2316 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002317 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002318 skip |= LogError(dst_state->image, vuid,
2319 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2320 "texel width & height (%d, %d).",
2321 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002322 }
2323
Dave Houlton94a00372017-12-14 15:08:47 -07002324 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002325 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2326 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002327 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002328 skip |= LogError(
2329 dst_state->image, vuid,
2330 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2331 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2332 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002333 }
2334
Dave Houltonee281a52017-12-08 13:51:02 -07002335 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2336 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2337 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002338 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002339 skip |= LogError(dst_state->image, vuid,
2340 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2341 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2342 "height (%d).",
2343 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002344 }
2345
Dave Houltonee281a52017-12-08 13:51:02 -07002346 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2347 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2348 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002349 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002350 skip |= LogError(
2351 dst_state->image, vuid,
2352 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2353 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2354 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002355 }
2356 } // Compressed
2357 }
2358 return skip;
2359}
2360
Dave Houltonc991cc92018-03-06 11:08:51 -07002361// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002362bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002363 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002364 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002365
2366 // Neither image is multiplane
2367 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2368 // If neither image is multi-plane the aspectMask member of src and dst must match
2369 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2370 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002371 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002372 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002373 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002374 }
2375 } else {
2376 // Source image multiplane checks
2377 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2378 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2379 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2380 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002381 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002382 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002383 }
2384 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2385 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2386 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002387 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002388 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002389 }
2390 // Single-plane to multi-plane
2391 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2392 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2393 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002394 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002395 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002396 }
2397
2398 // Dest image multiplane checks
2399 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2400 aspect = region.dstSubresource.aspectMask;
2401 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2402 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002403 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002404 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002405 }
2406 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2407 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2408 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002409 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002410 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002411 }
2412 // Multi-plane to single-plane
2413 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2414 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2415 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002416 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002417 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002418 }
2419 }
2420
2421 return skip;
2422}
2423
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002424bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2425 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002426 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002427 const auto *cb_node = GetCBState(commandBuffer);
2428 const auto *src_image_state = GetImageState(srcImage);
2429 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002430 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002431
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002432 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002433
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002434 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2435
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002436 for (uint32_t i = 0; i < regionCount; i++) {
2437 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002438
2439 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2440 VkExtent3D src_copy_extent = region.extent;
2441 VkExtent3D dst_copy_extent =
2442 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2443
Dave Houlton6f9059e2017-05-02 17:15:13 -06002444 bool slice_override = false;
2445 uint32_t depth_slices = 0;
2446
2447 // Special case for copying between a 1D/2D array and a 3D image
2448 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2449 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2450 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002451 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002452 slice_override = (depth_slices != 1);
2453 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2454 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002455 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002456 slice_override = (depth_slices != 1);
2457 }
2458
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002459 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2460 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2461 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002462 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002463 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002464 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002465 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002466 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2467 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002468 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002469 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2470 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002471
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002472 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002473 // No chance of mismatch if we're overriding depth slice count
2474 if (!slice_override) {
2475 // The number of depth slices in srcSubresource and dstSubresource must match
2476 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2477 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002478 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2479 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002480 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002481 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2482 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002483 if (src_slices != dst_slices) {
2484 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002485 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002486 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002487 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002488 }
2489 }
2490 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002491 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002492 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002493 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002494 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002495 << "] do not match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002496 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002497 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002498 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002499
Dave Houltonc991cc92018-03-06 11:08:51 -07002500 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002501 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002502 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002503 }
2504
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002505 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002506 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2507 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002508 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002509 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002510 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002511 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002512
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002513 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002514 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002515 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002516 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002517 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002518 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002519 }
2520
2521 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002522 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002523 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002524 ss << "vkCmdCopyImage(): pRegion[" << i
2525 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002526 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002527 }
2528
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002529 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2530 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2531 // The source region specified by a given element of regions must be a region that is contained within srcImage
Dave Houltonee281a52017-12-08 13:51:02 -07002532 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2533 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002534 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002535 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002536 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2537 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2538 << " ] exceeds the source image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002539 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002540 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002541
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002542 // The destination region specified by a given element of regions must be a region that is contained within dst_image
Dave Houltonee281a52017-12-08 13:51:02 -07002543 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2544 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002545 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002546 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002547 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2548 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2549 << " ] exceeds the destination image dimensions";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002550 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002551 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002552 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002553
Dave Houltonfc1a4052017-04-27 14:32:45 -06002554 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002555 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2556 if (slice_override) src_copy_extent.depth = depth_slices;
2557 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002558 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002559 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002560 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2561 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2562 "width [%1d].",
2563 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002564 }
2565
2566 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002567 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002568 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2569 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2570 "height [%1d].",
2571 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002572 }
2573 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002574 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002575 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2576 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2577 "depth [%1d].",
2578 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002579 }
2580
Dave Houltonee281a52017-12-08 13:51:02 -07002581 // Adjust dest extent if necessary
2582 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2583 if (slice_override) dst_copy_extent.depth = depth_slices;
2584
2585 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002586 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002587 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2588 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2589 "width [%1d].",
2590 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002591 }
2592 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002593 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2594 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2595 "height [%1d].",
2596 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002597 }
2598 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002599 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2600 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2601 "depth [%1d].",
2602 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002603 }
2604
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002605 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2606 // must not overlap in memory
2607 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002608 for (uint32_t j = 0; j < regionCount; j++) {
2609 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002610 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002611 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002612 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002613 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002614 }
2615 }
2616 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002617
2618 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2619 if (device_extensions.vk_khr_maintenance1) {
2620 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2621 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2622 (src_copy_extent.depth != 1)) {
2623 skip |= LogError(
2624 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2625 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2626 src_copy_extent.depth);
2627 }
2628 } else {
2629 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2630 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2631 (src_copy_extent.depth != 1)) {
2632 skip |= LogError(
2633 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2634 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2635 src_copy_extent.depth);
2636 }
2637 }
2638
2639 // Check if 2D with 3D and depth not equal to 2D layerCount
2640 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2641 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2642 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2643 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2644 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2645 "srcSubresource.layerCount (%u)",
2646 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2647 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2648 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2649 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2650 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2651 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2652 "dstSubresource.layerCount (%u)",
2653 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2654 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002655 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002656
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002657 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2658 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2659 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002660 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002661 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2662 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002663 skip |= LogError(command_buffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002664 }
2665 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002666 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002667 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002668 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002669 }
2670 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002671
Dave Houlton33c22b72017-02-28 13:16:02 -07002672 // Source and dest image sample counts must match
2673 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2674 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002675 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002676 }
2677
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002678 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2679 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002680 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002681 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2682 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2683 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2684 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002685 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002686 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2687 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2688 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2689 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002690 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002691 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002692 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002693 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2694 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002695 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002696 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2697 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2698 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2699 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2700 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2701 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002702 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002703 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002704 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2705 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002706 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002707 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2708 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002709 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2710 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002711 }
2712
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002713 return skip;
2714}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002715
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002716void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2717 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2718 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002719 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2720 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002721 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002722 auto src_image_state = GetImageState(srcImage);
2723 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002724
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002725 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002726 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002727 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2728 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002729 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002730}
2731
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002732// Returns true if sub_rect is entirely contained within rect
2733static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2734 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2735 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2736 return false;
2737 return true;
2738}
2739
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002740bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002741 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2742 const VkRect2D &render_area, uint32_t rect_count,
2743 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002744 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002745 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2746 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002747 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002748 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002749
2750 for (uint32_t j = 0; j < rect_count; j++) {
2751 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002752 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2753 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2754 "the current render pass instance.",
2755 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002756 }
2757
2758 if (image_view_state) {
2759 // The layers specified by a given element of pRects must be contained within every attachment that
2760 // pAttachments refers to
2761 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2762 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2763 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002764 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2765 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2766 "of pAttachment[%d].",
2767 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002768 }
2769 }
2770 }
2771 return skip;
2772}
2773
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002774bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2775 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002776 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002777 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002778 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002779 if (!cb_node) return skip;
2780
2781 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2782 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2783 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002784 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002785
2786 // Validate that attachment is in reference list of active subpass
2787 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002788 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002789 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002790 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002791 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002792 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002793
John Zulauf3a548ef2019-02-01 16:14:07 -07002794 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2795 auto clear_desc = &pAttachments[attachment_index];
2796 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002797
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002798 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002799 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002800 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002801 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002802 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002803 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2804 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2805 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2806 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002807 skip |= LogError(
2808 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2809 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2810 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2811 attachment_index, clear_desc->colorAttachment,
2812 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2813 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002814
John Zulauff2582972019-02-09 14:53:30 -07002815 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2816 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002817 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002818 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2819 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
2820 " subpass %u. colorAttachmentCount=%u",
2821 attachment_index, clear_desc->colorAttachment,
2822 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2823 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002824 }
John Zulauff2582972019-02-09 14:53:30 -07002825 fb_attachment = color_attachment;
2826
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002827 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2828 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2829 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002830 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002831 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002832 }
2833 } else { // Must be depth and/or stencil
2834 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2835 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002836 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002837 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002838 }
2839 if (!subpass_desc->pDepthStencilAttachment ||
2840 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002841 skip |= LogPerformanceWarning(
2842 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002843 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002844 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002845 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002846 }
2847 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002848 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002849 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2850 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002851 }
2852 }
2853 }
2854 return skip;
2855}
2856
2857void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2858 const VkClearAttachment *pAttachments, uint32_t rectCount,
2859 const VkClearRect *pRects) {
2860 auto *cb_node = GetCBState(commandBuffer);
2861 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
2862 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2863 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
2864 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
2865 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2866 const auto clear_desc = &pAttachments[attachment_index];
2867 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2868 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
2869 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
2870 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2871 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2872 subpass_desc->pDepthStencilAttachment) {
2873 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
2874 }
2875 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002876 if (!clear_rect_copy) {
2877 // We need a copy of the clear rectangles that will persist until the last lambda executes
2878 // but we want to create it as lazily as possible
2879 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002880 }
John Zulauf441558b2019-08-12 11:47:39 -06002881 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2882 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002883 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06002884 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002885 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06002886 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002887 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2888 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002889 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2890 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002891 return skip;
2892 };
2893 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002894 }
2895 }
2896 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002897}
2898
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002899bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2900 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002901 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002902 const auto *cb_node = GetCBState(commandBuffer);
2903 const auto *src_image_state = GetImageState(srcImage);
2904 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002905
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002906 bool skip = false;
2907 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002908 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2909 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002910 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002911 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002912 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2913 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002914 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2915 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002916
Cort Stratton7df30962018-05-17 19:45:57 -07002917 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002918 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002919 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002920 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2921 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2922 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002923 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002924 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2925 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002926 // For each region, the number of layers in the image subresource should not be zero
2927 // For each region, src and dest image aspect must be color only
2928 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002929 skip |=
2930 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2931 skip |=
2932 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002933 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002934 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2935 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002936 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002937 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2938 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002939 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2940 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2941 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2942 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2943 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002944 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2945 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002946 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002947 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2948 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002949
2950 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002951 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002952 skip |= LogError(
2953 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002954 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002955 }
Cort Stratton7df30962018-05-17 19:45:57 -07002956 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002957 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2958 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2959 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002960 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002961 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002962 }
2963 }
2964
2965 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2966 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002967 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002968 }
2969 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2970 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002971 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002972 }
2973 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2974 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002975 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002976 }
2977 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2978 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002979 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002980 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002981 } else {
2982 assert(0);
2983 }
2984 return skip;
2985}
2986
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002987bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2988 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002989 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002990 const auto *cb_node = GetCBState(commandBuffer);
2991 const auto *src_image_state = GetImageState(srcImage);
2992 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002993
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002994 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002995 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002996 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07002997 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002998 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002999 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003000 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003001 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003002 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003003 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3004 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003005 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003006 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3007 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003008 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003009 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3010 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003011 skip |=
3012 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003013 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3014 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003015 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003016 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003017 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003018 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003019
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003020 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003021
Dave Houlton33c2d252017-06-09 17:08:32 -06003022 VkFormat src_format = src_image_state->createInfo.format;
3023 VkFormat dst_format = dst_image_state->createInfo.format;
3024 VkImageType src_type = src_image_state->createInfo.imageType;
3025 VkImageType dst_type = dst_image_state->createInfo.imageType;
3026
Cort Stratton186b1a22018-05-01 20:18:06 -04003027 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003028 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003029 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3030 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003031 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003032 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3033 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3034 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003035 }
3036
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003037 if (FormatRequiresYcbcrConversion(src_format)) {
3038 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3039 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3040 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3041 string_VkFormat(src_format));
3042 }
3043
3044 if (FormatRequiresYcbcrConversion(dst_format)) {
3045 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3046 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3047 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3048 string_VkFormat(dst_format));
3049 }
3050
Dave Houlton33c2d252017-06-09 17:08:32 -06003051 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003052 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3053 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003054 }
3055
Dave Houlton33c2d252017-06-09 17:08:32 -06003056 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3057 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003058 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00228",
3059 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003060 }
3061
3062 // Validate consistency for unsigned formats
3063 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3064 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003065 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003066 << "the other one must also have unsigned integer format. "
3067 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003068 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003069 }
3070
3071 // Validate consistency for signed formats
3072 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3073 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003074 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003075 << "the other one must also have signed integer format. "
3076 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003077 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003078 }
3079
3080 // Validate filter for Depth/Stencil formats
3081 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3082 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003083 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003084 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003085 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003086 }
3087
3088 // Validate aspect bits and formats for depth/stencil images
3089 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3090 if (src_format != dst_format) {
3091 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003092 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003093 << "stencil, the other one must have exactly the same format. "
3094 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3095 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003096 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003097 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003098 } // Depth or Stencil
3099
3100 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003101 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003102 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003103 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3104 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3105 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003106 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003107 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3108 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003109 for (uint32_t i = 0; i < regionCount; i++) {
3110 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003111 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003112 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003113 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3114 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003115 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003116 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3117 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003118 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3119 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3120 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003121 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003122 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003123 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003124 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003125 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3126 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003127 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003128 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3129 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003130 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003131 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3132 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003133 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003134 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003135 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003136 }
Dave Houlton48989f32017-05-26 15:01:46 -06003137 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3138 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003139 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003140 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003141 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003142 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003143
3144 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003145 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003146 skip |= LogError(
3147 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003148 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003149 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003150
Dave Houlton48989f32017-05-26 15:01:46 -06003151 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003152 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3153 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003154 }
Dave Houlton48989f32017-05-26 15:01:46 -06003155
Dave Houlton33c2d252017-06-09 17:08:32 -06003156 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003157 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3158 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3159 "image format %s.",
3160 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003161 }
3162
3163 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003164 skip |= LogError(
3165 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003166 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3167 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003168 }
3169
Dave Houlton48989f32017-05-26 15:01:46 -06003170 // Validate source image offsets
3171 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003172 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003173 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003174 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003175 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3176 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3177 "of (%1d, %1d). These must be (0, 1).",
3178 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003179 }
3180 }
3181
Dave Houlton33c2d252017-06-09 17:08:32 -06003182 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003183 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003184 skip |=
3185 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3186 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3187 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3188 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003189 }
3190 }
3191
Dave Houlton33c2d252017-06-09 17:08:32 -06003192 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003193 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3194 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003195 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003196 skip |= LogError(
3197 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003198 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3199 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003200 }
3201 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3202 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003203 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003204 skip |= LogError(
3205 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003206 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003207 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003208 }
3209 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3210 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003211 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003212 skip |= LogError(
3213 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003214 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3215 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003216 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003217 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003218 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3219 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003220 }
Dave Houlton48989f32017-05-26 15:01:46 -06003221
3222 // Validate dest image offsets
3223 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003224 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003225 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003226 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003227 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3228 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3229 "(%1d, %1d). These must be (0, 1).",
3230 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003231 }
3232 }
3233
Dave Houlton33c2d252017-06-09 17:08:32 -06003234 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003235 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003236 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3237 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3238 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3239 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003240 }
3241 }
3242
Dave Houlton33c2d252017-06-09 17:08:32 -06003243 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003244 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3245 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003246 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003247 skip |= LogError(
3248 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003249 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3250 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003251 }
3252 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3253 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003254 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003255 skip |= LogError(
3256 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003257 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003258 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003259 }
3260 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3261 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003262 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003263 skip |= LogError(
3264 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003265 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3266 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003267 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003268 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003269 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3270 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003271 }
3272
Dave Houlton33c2d252017-06-09 17:08:32 -06003273 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3274 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3275 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003276 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003277 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3278 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3279 "layerCount other than 1.",
3280 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003281 }
3282 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003283 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003284 } else {
3285 assert(0);
3286 }
3287 return skip;
3288}
3289
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003290void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3291 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3292 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003293 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3294 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003295 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003296 auto src_image_state = GetImageState(srcImage);
3297 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003298
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003299 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003300 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003301 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3302 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003303 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003304}
3305
John Zulauf2076e812020-01-08 14:55:54 -07003306GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3307 assert(map);
3308 // This approach allows for a single hash lookup or/create new
3309 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3310 if (inserted.second) {
3311 assert(nullptr == inserted.first->second.get());
3312 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.range_encoder.SubresourceCount());
3313 inserted.first->second.reset(layout_map);
3314 return layout_map;
3315 } else {
3316 assert(nullptr != inserted.first->second.get());
3317 return inserted.first->second.get();
3318 }
3319 return nullptr;
3320}
3321
3322const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3323 auto it = map.find(image);
3324 if (it != map.end()) {
3325 return it->second.get();
3326 }
3327 return nullptr;
3328}
3329
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003330// 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 -07003331bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3332 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003333 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003334 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003335 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003336 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003337 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003338 for (const auto &layout_map_entry : pCB->image_layout_map) {
3339 const auto image = layout_map_entry.first;
3340 const auto *image_state = GetImageState(image);
3341 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003342 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003343 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003344 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003345 if (initial_layout_map.empty()) continue;
3346
3347 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3348 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3349 if (global_map == nullptr) {
3350 global_map = &empty_map;
3351 }
3352
3353 // Note: don't know if it would matter
3354 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3355
3356 auto pos = initial_layout_map.begin();
3357 const auto end = initial_layout_map.end();
3358 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3359 pos->first.begin);
3360 while (pos != end) {
3361 VkImageLayout initial_layout = pos->second; // Point directly into the RangeMap iterated but the view
3362 VkImageLayout image_layout = kInvalidLayout;
3363 // current_layout.seek(pos->first.begin);
3364 if (current_layout->range.empty()) break; // When we are past the end of data in overlay and global... stop looking
3365 if (current_layout->pos_A->valid) {
3366 image_layout = current_layout->pos_A->lower_bound->second;
3367 } else if (current_layout->pos_B->valid) {
3368 image_layout = current_layout->pos_B->lower_bound->second;
3369 }
3370 const auto intersected_range = pos->first & current_layout->range;
3371 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3372 // TODO: Set memory invalid which is in mem_tracker currently
3373 } else if (image_layout != initial_layout) {
3374 // Need to look up the inital layout *state* to get a bit more information
3375 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3376 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3377 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3378 if (!matches) {
3379 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
3380 // We can report all the errors for the intersected range directly
3381 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
3382 const auto subresource = image_state->range_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003383 skip |= LogError(
3384 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003385 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003386 "to be in layout %s--instead, current layout is %s.%s",
John Zulauf2076e812020-01-08 14:55:54 -07003387 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
3388 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout),
locke-lunarga344e7c2020-01-02 19:48:53 -07003389 formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003390 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003391 }
3392 }
John Zulauf2076e812020-01-08 14:55:54 -07003393 if (pos->first.includes(intersected_range.end)) {
3394 current_layout.seek(intersected_range.end);
3395 } else {
3396 ++pos;
3397 if (pos != end) {
3398 current_layout.seek(pos->first.begin);
3399 }
3400 }
John Zulauff660ad62019-03-23 07:16:05 -06003401 }
3402
3403 // Update all layout set operations (which will be a subset of the initial_layouts
John Zulauf2076e812020-01-08 14:55:54 -07003404 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003405 }
John Zulauff660ad62019-03-23 07:16:05 -06003406
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003407 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003408}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003409
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003410void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003411 for (const auto &layout_map_entry : pCB->image_layout_map) {
3412 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003413 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003414 const auto *image_state = GetImageState(image);
3415 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003416 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3417 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003418 }
3419}
3420
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003421// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003422// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3423// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003424bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3425 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003426 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003427 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003428 const char *vuid;
3429 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3430
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003431 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3432 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003433 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3434 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3435 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003436 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
3437 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3438 string_VkImageLayout(first_layout));
Shannon McPherson3ea65132018-12-05 10:37:39 -07003439 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3440 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003441 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
3442 "Cannot clear attachment %d with invalid first layout %s.", attachment,
3443 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003444 }
3445 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003446 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3447 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003448 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003449 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3450 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003451 }
3452 }
3453
3454 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3455 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003456 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003457 skip |= LogError(device, vuid, "Cannot clear attachment %d with invalid first layout %s.", attachment,
3458 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003459 }
3460 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003461 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003462}
3463
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003464bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3465 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003466 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003467 const char *vuid;
3468 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003469
Jason Ekstranda1906302017-12-03 20:16:32 -08003470 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3471 VkFormat format = pCreateInfo->pAttachments[i].format;
3472 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3473 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3474 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003475 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3476 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3477 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3478 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3479 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003480 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003481 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003482 skip |=
3483 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3484 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3485 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3486 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3487 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003488 }
3489 }
3490 }
3491
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003492 // Track when we're observing the first use of an attachment
3493 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3494 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003495 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003496
3497 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3498 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3499 auto attach_index = subpass.pInputAttachments[j].attachment;
3500 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003501 switch (subpass.pInputAttachments[j].layout) {
3502 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3503 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3504 // These are ideal.
3505 break;
3506
3507 case VK_IMAGE_LAYOUT_GENERAL:
3508 // May not be optimal. TODO: reconsider this warning based on other constraints.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003509 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3510 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
Cort Stratton7547f772017-05-04 15:18:52 -07003511 break;
3512
Tobias Hectorbbb12282018-10-22 15:17:59 +01003513 case VK_IMAGE_LAYOUT_UNDEFINED:
3514 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003515 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003516 skip |= LogError(device, vuid,
3517 "Layout for input attachment reference %u in subpass %u is %s but must be "
3518 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3519 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003520 break;
3521
Piers Daniell9af77cd2019-10-16 13:54:12 -06003522 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3523 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3524 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3525 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003526 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003527 skip |= LogError(
3528 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003529 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3530 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3531 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3532 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3533 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003534 skip |= LogError(
3535 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003536 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3537 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3538 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3539 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3540 } else if ((subpass.pInputAttachments[j].aspectMask &
3541 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3542 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3543 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3544 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3545 const auto *attachment_reference_stencil_layout =
3546 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3547 if (attachment_reference_stencil_layout) {
3548 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3549 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3550 attachment_reference_stencil_layout->stencilLayout ==
3551 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3552 attachment_reference_stencil_layout->stencilLayout ==
3553 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3554 attachment_reference_stencil_layout->stencilLayout ==
3555 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3556 attachment_reference_stencil_layout->stencilLayout ==
3557 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3558 attachment_reference_stencil_layout->stencilLayout ==
3559 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3560 attachment_reference_stencil_layout->stencilLayout ==
3561 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3562 attachment_reference_stencil_layout->stencilLayout ==
3563 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3564 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003565 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3566 "In the attachment reference %u in subpass %u with pNext chain instance "
3567 "VkAttachmentReferenceStencilLayoutKHR"
3568 "the stencilLayout member but must not be "
3569 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3570 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3571 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3572 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3573 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3574 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3575 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3576 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3577 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3578 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003579 }
3580 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003581 skip |= LogError(
3582 device, "VUID-VkAttachmentReference2-attachment-03315",
3583 "When the layout for input attachment reference %u in subpass %u is "
3584 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3585 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3586 "VkAttachmentReferenceStencilLayout instance.",
3587 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003588 }
3589 }
3590 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3591 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3592 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003593 skip |= LogError(
3594 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003595 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3596 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3597 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3598 j, i);
3599 }
3600 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3601 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3602 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003603 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3604 "When the aspectMask for input attachment reference %u in subpass %u is "
3605 "VK_IMAGE_ASPECT_STENCIL_BIT "
3606 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3607 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3608 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003609 }
3610 }
3611 break;
3612
Graeme Leese668a9862018-10-08 10:40:02 +01003613 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3614 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003615 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003616 break;
3617 } else {
3618 // Intentionally fall through to generic error message
3619 }
3620 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003621
Cort Stratton7547f772017-05-04 15:18:52 -07003622 default:
3623 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003624 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3625 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3626 string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003627 }
3628
Cort Stratton7547f772017-05-04 15:18:52 -07003629 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003630 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3631 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003632
3633 bool used_as_depth =
3634 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3635 bool used_as_color = false;
3636 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3637 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3638 }
3639 if (!used_as_depth && !used_as_color &&
3640 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003641 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003642 skip |= LogError(device, vuid,
3643 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3644 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003645 }
3646 }
3647 attach_first_use[attach_index] = false;
3648 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003649
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003650 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3651 auto attach_index = subpass.pColorAttachments[j].attachment;
3652 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3653
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003654 // TODO: Need a way to validate shared presentable images here, currently just allowing
3655 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3656 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003657 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003658 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003659 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003660 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3661 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003662 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003663
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003664 case VK_IMAGE_LAYOUT_GENERAL:
3665 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003666 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3667 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003668 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003669
Tobias Hectorbbb12282018-10-22 15:17:59 +01003670 case VK_IMAGE_LAYOUT_UNDEFINED:
3671 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003672 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003673 skip |= LogError(device, vuid,
3674 "Layout for color attachment reference %u in subpass %u is %s but should be "
3675 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3676 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003677 break;
3678
Piers Daniell9af77cd2019-10-16 13:54:12 -06003679 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3680 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3681 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3682 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003683 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003684 skip |= LogError(
3685 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003686 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3687 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3688 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3689 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3690 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003691 skip |= LogError(
3692 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003693 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3694 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3695 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3696 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3697 } else if ((subpass.pColorAttachments[j].aspectMask &
3698 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3699 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3700 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3701 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3702 const auto *attachment_reference_stencil_layout =
3703 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3704 if (attachment_reference_stencil_layout) {
3705 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3706 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3707 attachment_reference_stencil_layout->stencilLayout ==
3708 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3709 attachment_reference_stencil_layout->stencilLayout ==
3710 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3711 attachment_reference_stencil_layout->stencilLayout ==
3712 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3713 attachment_reference_stencil_layout->stencilLayout ==
3714 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3715 attachment_reference_stencil_layout->stencilLayout ==
3716 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3717 attachment_reference_stencil_layout->stencilLayout ==
3718 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3719 attachment_reference_stencil_layout->stencilLayout ==
3720 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3721 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003722 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3723 "In the attachment reference %u in subpass %u with pNext chain instance "
3724 "VkAttachmentReferenceStencilLayoutKHR"
3725 "the stencilLayout member but must not be "
3726 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3727 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3728 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3729 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3730 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3731 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3732 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3733 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3734 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3735 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003736 }
3737 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003738 skip |= LogError(
3739 device, "VUID-VkAttachmentReference2-attachment-03315",
3740 "When the layout for color attachment reference %u in subpass %u is "
3741 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3742 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3743 "VkAttachmentReferenceStencilLayout instance.",
3744 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003745 }
3746 }
3747 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3748 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3749 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003750 skip |= LogError(
3751 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003752 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3753 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3754 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3755 j, i);
3756 }
3757 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3758 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3759 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003760 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3761 "When the aspectMask for color attachment reference %u in subpass %u is "
3762 "VK_IMAGE_ASPECT_STENCIL_BIT "
3763 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3764 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3765 j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003766 }
3767 }
3768 break;
3769
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003770 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003771 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3772 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3773 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003774 }
3775
John Zulauf4eee2692019-02-09 16:14:25 -07003776 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3777 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3778 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003779 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003780 skip |= LogError(device, vuid,
3781 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
3782 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3783 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003784 }
3785
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003786 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003787 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3788 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003789 }
3790 attach_first_use[attach_index] = false;
3791 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003792
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003793 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3794 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003795 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3796 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3797 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003798 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003799
Dave Houltona9df0ce2018-02-07 10:51:23 -07003800 case VK_IMAGE_LAYOUT_GENERAL:
3801 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3802 // doing a bunch of transitions.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003803 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
3804 "GENERAL layout for depth attachment may not give optimal performance.");
Dave Houltona9df0ce2018-02-07 10:51:23 -07003805 break;
3806
Tobias Hectorbbb12282018-10-22 15:17:59 +01003807 case VK_IMAGE_LAYOUT_UNDEFINED:
3808 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003809 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003810 skip |= LogError(device, vuid,
3811 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3812 "layout or GENERAL.",
3813 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003814 break;
3815
Piers Daniell9af77cd2019-10-16 13:54:12 -06003816 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3817 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3818 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3819 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003820 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003821 skip |= LogError(
3822 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003823 "Layout for depth attachment reference in subpass %u is %s but must not be "
3824 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3825 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3826 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3827 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003828 skip |= LogError(
3829 device, "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003830 "Layout for depth attachment reference in subpass %u is %s but must not be "
3831 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3832 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3833 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3834 } else if ((subpass.pDepthStencilAttachment->aspectMask &
3835 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3836 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3837 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3838 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3839 const auto *attachment_reference_stencil_layout =
3840 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
3841 if (attachment_reference_stencil_layout) {
3842 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3843 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3844 attachment_reference_stencil_layout->stencilLayout ==
3845 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3846 attachment_reference_stencil_layout->stencilLayout ==
3847 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3848 attachment_reference_stencil_layout->stencilLayout ==
3849 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3850 attachment_reference_stencil_layout->stencilLayout ==
3851 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3852 attachment_reference_stencil_layout->stencilLayout ==
3853 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3854 attachment_reference_stencil_layout->stencilLayout ==
3855 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3856 attachment_reference_stencil_layout->stencilLayout ==
3857 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3858 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003859 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
3860 "In the attachment reference in subpass %u with pNext chain instance "
3861 "VkAttachmentReferenceStencilLayoutKHR"
3862 "the stencilLayout member but must not be "
3863 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3864 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3865 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3866 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3867 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3868 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3869 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3870 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3871 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3872 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003873 }
3874 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003875 skip |= LogError(
3876 device, "VUID-VkAttachmentReference2-attachment-03315",
3877 "When the layout for depth attachment reference in subpass %u is "
3878 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3879 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3880 "VkAttachmentReferenceStencilLayout instance.",
3881 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003882 }
3883 }
3884 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3885 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3886 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003887 skip |= LogError(
3888 device, "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003889 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3890 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3891 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3892 i);
3893 }
3894 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3895 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3896 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003897 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
3898 "When the aspectMask for depth attachment reference in subpass %u is "
3899 "VK_IMAGE_ASPECT_STENCIL_BIT "
3900 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3901 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3902 i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003903 }
3904 }
3905 break;
3906
Dave Houltona9df0ce2018-02-07 10:51:23 -07003907 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3908 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003909 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003910 break;
3911 } else {
3912 // Intentionally fall through to generic error message
3913 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003914 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003915
Dave Houltona9df0ce2018-02-07 10:51:23 -07003916 default:
3917 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003918 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
3919 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3920 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3921 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003922 }
3923
3924 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3925 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003926 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3927 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003928 }
3929 attach_first_use[attach_index] = false;
3930 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003931 }
3932 return skip;
3933}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003934
Mark Lobodzinski96210742017-02-09 10:33:46 -07003935// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3936// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003937template <typename T1>
3938bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
3939 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
3940 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003941 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003942 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003943 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003944 if (strict) {
3945 correct_usage = ((actual & desired) == desired);
3946 } else {
3947 correct_usage = ((actual & desired) != 0);
3948 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003949
Mark Lobodzinski96210742017-02-09 10:33:46 -07003950 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003951 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003952 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003953 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
3954 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3955 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003956 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003957 skip = LogError(object, msgCode,
3958 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3959 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003960 }
3961 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003962 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003963}
3964
3965// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3966// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003967bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003968 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003969 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06003970 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003971}
3972
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003973bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06003974 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003975 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003976 bool skip = false;
3977 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3978 if ((format_properties.linearTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003979 skip |=
3980 LogError(image_state->image, linear_vuid, "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.",
3981 func_name, format_properties.linearTilingFeatures, image_state->createInfo.format,
3982 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003983 }
3984 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3985 if ((format_properties.optimalTilingFeatures & desired) != desired) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003986 skip |= LogError(image_state->image, optimal_vuid,
3987 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
3988 format_properties.optimalTilingFeatures, image_state->createInfo.format,
3989 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003990 }
3991 }
3992 return skip;
3993}
3994
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003995bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003996 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07003997 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003998 // layerCount must not be zero
3999 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004000 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4001 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004002 }
4003 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4004 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004005 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4006 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004007 }
4008 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4009 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4010 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004011 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4012 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4013 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4014 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004015 }
4016 return skip;
4017}
4018
Mark Lobodzinski96210742017-02-09 10:33:46 -07004019// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4020// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004021bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004022 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004023 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004024 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004025}
4026
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004027bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004028 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004029 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004030
4031 const VkDeviceSize &range = pCreateInfo->range;
4032 if (range != VK_WHOLE_SIZE) {
4033 // Range must be greater than 0
4034 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004035 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
4036 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4037 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4038 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004039 }
4040 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004041 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4042 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004043 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
4044 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4045 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4046 "(%" PRIu32 ").",
4047 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004048 }
4049 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004050 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004051 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
4052 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4053 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4054 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4055 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004056 }
4057 // The sum of range and offset must be less than or equal to the size of buffer
4058 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004059 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
4060 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4061 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4062 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4063 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004064 }
4065 }
4066 return skip;
4067}
4068
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004069bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004070 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004071 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004072 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4073 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004074 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
4075 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4076 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004077 }
4078 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4079 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004080 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
4081 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4082 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004083 }
4084 return skip;
4085}
4086
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004087bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004088 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004089 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004090
Dave Houltond8ed0212018-05-16 17:18:24 -06004091 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004092
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004093 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004094 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00915",
4095 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
4096 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004097 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004098
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004099 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004100 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00916",
4101 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
4102 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004103 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004104
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004105 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004106 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-00917",
4107 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
4108 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004109 }
Jeff Bolz87697532019-01-11 22:54:00 -06004110
4111 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4112 if (chained_devaddr_struct) {
4113 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4114 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004115 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4116 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4117 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004118 }
4119 }
4120
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004121 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4122 if (chained_opaqueaddr_struct) {
4123 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4124 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004125 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4126 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4127 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004128 }
4129 }
4130
Shannon McPherson4984e642019-12-05 13:04:34 -07004131 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004132 !enabled_features.core12.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004133 skip |= LogError(
4134 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004135 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4136 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4137 }
4138
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004139 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004140 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4141 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4142 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004143 }
4144
Mark Lobodzinski96210742017-02-09 10:33:46 -07004145 return skip;
4146}
4147
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004148bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004149 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004150 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004151 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004152 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4153 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004154 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004155 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4156 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004157 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004158 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4159 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4160 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004161
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004162 // Buffer view offset must be less than the size of buffer
4163 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004164 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
4165 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4166 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4167 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004168 }
4169
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004170 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004171 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4172 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4173 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004174 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-02749",
4175 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4176 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4177 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004178 }
4179
4180 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4181 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4182 if ((elementSize % 3) == 0) {
4183 elementSize /= 3;
4184 }
4185 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4186 VkDeviceSize alignmentRequirement =
4187 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4188 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4189 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4190 }
4191 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004192 skip |= LogError(
4193 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004194 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4195 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4196 ") must be a multiple of the lesser of "
4197 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4198 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4199 "(%" PRId32
4200 ") is VK_TRUE, the size of a texel of the requested format. "
4201 "If the size of a texel is a multiple of three bytes, then the size of a "
4202 "single component of format is used instead",
4203 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4204 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4205 }
4206 }
4207 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4208 VkDeviceSize alignmentRequirement =
4209 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4210 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4211 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4212 }
4213 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004214 skip |= LogError(
4215 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
Jeff Bolzd5554e62019-07-19 13:23:52 -05004216 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4217 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4218 ") must be a multiple of the lesser of "
4219 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4220 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4221 "(%" PRId32
4222 ") is VK_TRUE, the size of a texel of the requested format. "
4223 "If the size of a texel is a multiple of three bytes, then the size of a "
4224 "single component of format is used instead",
4225 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4226 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4227 }
4228 }
4229 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004230
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004231 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004232
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004233 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004234 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004235 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004236}
4237
Mark Lobodzinski602de982017-02-09 11:01:33 -07004238// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004239bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004240 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004241 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004242
Dave Houlton1d2022c2017-03-29 11:43:58 -06004243 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004244 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004245 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 -07004246 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004247 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 -07004248 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004249 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004250 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004251 skip |= LogError(image, vuid,
4252 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4253 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4254 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004255 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004256 skip |= LogError(image, vuid,
4257 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4258 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4259 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004260 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004261 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004262 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004263 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 -07004264 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004265 skip |=
4266 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 -07004267 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004268 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004269 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004270 skip |=
4271 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 -07004272 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004273 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4274 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004275 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004276 } else if (FormatIsMultiplane(format)) {
4277 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4278 if (3 == FormatPlaneCount(format)) {
4279 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4280 }
4281 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004282 skip |=
4283 LogError(image, vuid,
4284 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4285 "set, where n = [0, 1, 2].",
4286 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004287 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004288 }
4289 return skip;
4290}
4291
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004292bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4293 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004294 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4295 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004296 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004297
4298 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004299 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004300 skip |= LogError(image, errorCodes.base_mip_err,
4301 "%s: %s.baseMipLevel (= %" PRIu32
4302 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4303 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004304 }
Petr Kraus4d718682017-05-18 03:38:41 +02004305
Petr Krausffa94af2017-08-08 21:46:02 +02004306 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4307 if (subresourceRange.levelCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004308 skip |= LogError(image, errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004309 } else {
4310 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004311
Petr Krausffa94af2017-08-08 21:46:02 +02004312 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004313 skip |= LogError(image, errorCodes.mip_count_err,
4314 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4315 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4316 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4317 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004318 }
Petr Kraus4d718682017-05-18 03:38:41 +02004319 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004320 }
Petr Kraus4d718682017-05-18 03:38:41 +02004321
4322 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004323 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004324 skip |= LogError(image, errorCodes.base_layer_err,
4325 "%s: %s.baseArrayLayer (= %" PRIu32
4326 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4327 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004328 }
Petr Kraus4d718682017-05-18 03:38:41 +02004329
Petr Krausffa94af2017-08-08 21:46:02 +02004330 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4331 if (subresourceRange.layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004332 skip |= LogError(image, errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004333 } else {
4334 const uint64_t necessary_layer_count =
4335 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004336
Petr Krausffa94af2017-08-08 21:46:02 +02004337 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004338 skip |= LogError(image, errorCodes.layer_count_err,
4339 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4340 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4341 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4342 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004343 }
Petr Kraus4d718682017-05-18 03:38:41 +02004344 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004345 }
Petr Kraus4d718682017-05-18 03:38:41 +02004346
Mark Lobodzinski602de982017-02-09 11:01:33 -07004347 return skip;
4348}
4349
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004350bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004351 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004352 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004353 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4354 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4355 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4356
4357 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4358 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4359
4360 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004361 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4362 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004363 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004364 : "VUID-VkImageViewCreateInfo-image-01482")
4365 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4366 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004367 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004368 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4369 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004370
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004371 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004372 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004373 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004374}
4375
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004376bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004377 const VkImageSubresourceRange &subresourceRange,
4378 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004379 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004380 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4381 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4382 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4383 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004384
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004385 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004386 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004387 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004388}
4389
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004390bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004391 const VkImageSubresourceRange &subresourceRange,
4392 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004393 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004394 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4395 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4396 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4397 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004398
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004399 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004400 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4401 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004402}
4403
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004404bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004405 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004406 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004407 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004408 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4409 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4410 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4411 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004412
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004413 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004414 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004415}
4416
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004417bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004418 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004419 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004420 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004421 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004422 skip |=
4423 ValidateImageUsageFlags(image_state,
4424 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4425 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4426 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4427 false, kVUIDUndefined, "vkCreateImageView()",
4428 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4429 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004430 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004431 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004432 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004433 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004434 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004435 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004436
4437 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4438 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004439 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4440 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004441 VkFormat view_format = pCreateInfo->format;
4442 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004443 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004444 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004445
Dave Houltonbd2e2622018-04-10 16:41:14 -06004446 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004447 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004448 if (chained_ivuci_struct) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004449 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance2) {
4450 if (!device_extensions.vk_ext_separate_stencil_usage) {
4451 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004452 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4453 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4454 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004455 }
4456 } else {
4457 const auto image_stencil_struct =
4458 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4459 if (image_stencil_struct == nullptr) {
4460 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004461 skip |= LogError(
4462 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004463 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4464 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4465 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4466 }
4467 } else {
4468 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4469 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4470 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004471 skip |= LogError(
4472 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004473 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4474 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4475 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4476 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4477 }
4478 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4479 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004480 skip |= LogError(
4481 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004482 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4483 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4484 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4485 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4486 }
4487 }
4488 }
4489 }
4490
Dave Houltonbd2e2622018-04-10 16:41:14 -06004491 image_usage = chained_ivuci_struct->usage;
4492 }
4493
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004494 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4495 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004496 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004497 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004498 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004499 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004500 std::stringstream ss;
4501 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004502 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004503 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004504 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004505 }
4506 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004507 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004508 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4509 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4510 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4511 std::stringstream ss;
4512 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004513 << " is not in the same format compatibility class as "
4514 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004515 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4516 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004517 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01018", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004518 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004519 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004520 }
4521 } else {
4522 // Format MUST be IDENTICAL to the format the image was created with
4523 if (image_format != view_format) {
4524 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004525 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004526 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004527 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004528 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004529 }
4530 }
4531
sfricke-samsungd40eda42020-02-09 17:54:31 -08004532 // Validate feature set if using CUBE_ARRAY
4533 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) && (enabled_features.core.imageCubeArray == false)) {
4534 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-viewType-01004",
4535 "vkCreateImageView(): pCreateInfo->viewType can't be VK_IMAGE_VIEW_TYPE_CUBE_ARRAY without "
4536 "enabling the imageCubeArray feature.");
4537 }
4538
Mark Lobodzinski602de982017-02-09 11:01:33 -07004539 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004540 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004541
4542 switch (image_type) {
4543 case VK_IMAGE_TYPE_1D:
4544 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004545 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4546 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4547 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004548 }
4549 break;
4550 case VK_IMAGE_TYPE_2D:
4551 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4552 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4553 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004554 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4555 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4556 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004557 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004558 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4559 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4560 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004561 }
4562 }
4563 break;
4564 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004565 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004566 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4567 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4568 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004569 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004570 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4571 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4572 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004573 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4574 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004575 skip |= LogError(
4576 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4577 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4578 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4579 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4580 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004581 }
4582 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004583 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4584 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4585 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004586 }
4587 }
4588 } else {
4589 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004590 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4591 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4592 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004593 }
4594 }
4595 break;
4596 default:
4597 break;
4598 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004599
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004600 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004601 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004602 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004603 }
4604
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004605 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004606 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4607 : format_properties.optimalTilingFeatures;
4608
4609 if (tiling_features == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004610 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-None-02273",
4611 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4612 "physical device.",
4613 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004614 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004615 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02274",
4616 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4617 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4618 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004619 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004620 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02275",
4621 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4622 "VK_IMAGE_USAGE_STORAGE_BIT.",
4623 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004624 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4625 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004626 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02276",
4627 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4628 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4629 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004630 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4631 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004632 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02277",
4633 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4634 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4635 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
sfricke-samsungd40eda42020-02-09 17:54:31 -08004636 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4637 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4638 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-usage-02652",
4639 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4640 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4641 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004642 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004643
Jeff Bolz9af91c52018-09-01 21:53:57 -05004644 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4645 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004646 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4647 "vkCreateImageView() If image was created with usage containing "
4648 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4649 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004650 }
4651 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004652 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4653 "vkCreateImageView() If image was created with usage containing "
4654 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004655 }
4656 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004657 }
4658 return skip;
4659}
4660
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004661bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4662 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004663 bool skip = false;
4664
4665 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4666 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4667 VkDeviceSize src_min = UINT64_MAX;
4668 VkDeviceSize src_max = 0;
4669 VkDeviceSize dst_min = UINT64_MAX;
4670 VkDeviceSize dst_max = 0;
4671
4672 for (uint32_t i = 0; i < regionCount; i++) {
4673 src_min = std::min(src_min, pRegions[i].srcOffset);
4674 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4675 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4676 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4677
4678 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4679 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004680 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
4681 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4682 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4683 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004684 }
4685
4686 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4687 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004688 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
4689 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4690 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4691 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004692 }
4693
4694 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4695 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004696 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
4697 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4698 ") is greater than the source buffer size (%" PRIuLEAST64
4699 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4700 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004701 }
4702
4703 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4704 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004705 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
4706 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4707 ") is greater than the destination buffer size (%" PRIuLEAST64
4708 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4709 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004710 }
4711 }
4712
4713 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4714 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4715 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004716 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
4717 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004718 }
4719 }
4720
4721 return skip;
4722}
4723
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004724bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004725 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004726 const auto cb_node = GetCBState(commandBuffer);
4727 const auto src_buffer_state = GetBufferState(srcBuffer);
4728 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004729
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004730 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004731 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4732 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004733 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004734 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004735 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4736 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004737 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004738 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4739 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004740 skip |=
4741 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4742 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004743 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4744 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004745 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004746 return skip;
4747}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004748
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004749bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004750 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004751 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004752 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004753 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
4754 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004755 } else {
4756 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004757 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
4758 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004759 }
4760 }
4761 return skip;
4762}
4763
Jeff Bolz5c801d12019-10-09 10:38:45 -05004764bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4765 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004766 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004767 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004768
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004769 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004770 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004771 skip |=
4772 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004773 }
4774 return skip;
4775}
4776
Jeff Bolz5c801d12019-10-09 10:38:45 -05004777bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004778 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004779
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004780 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004781 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004782 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004783 }
4784 return skip;
4785}
4786
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004787bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004788 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004789 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004790 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004791 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004792 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004793 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004794 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004795 }
4796 return skip;
4797}
4798
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004799bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004800 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004801 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004802 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004803 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004804 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004805 skip |=
4806 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4807 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004808 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004809 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004810 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4811 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004812 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004813
4814 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004815 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
4816 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
4817 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
4818 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004819 }
4820
4821 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004822 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
4823 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
4824 ") minus dstOffset (0x%" PRIxLEAST64 ").",
4825 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004826 }
4827
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004828 return skip;
4829}
4830
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004831bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
4832 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004833 bool skip = false;
4834
4835 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004836 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4837 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004838 skip |=
4839 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
4840 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
4841 "and 1, respectively.",
4842 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004843 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004844 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004845
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004846 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4847 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004848 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
4849 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
4850 "must be 0 and 1, respectively.",
4851 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004852 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004853 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004854
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004855 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4856 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004857 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
4858 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4859 "For 3D images these must be 0 and 1, respectively.",
4860 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004861 }
4862 }
4863
4864 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004865 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004866 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4867
Dave Houltona585d132019-01-18 13:05:42 -07004868 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004869 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00193",
4870 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
4871 " must be a multiple of this format's texel size (%" PRIu32 ").",
4872 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004873 }
4874
4875 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004876 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004877 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00194",
4878 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4879 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004880 }
4881
4882 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4883 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004884 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004885 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
4886 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4887 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004888 }
4889
4890 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4891 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004892 skip |= LogError(
4893 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004894 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4895 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004896 }
4897
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004898 // Calculate adjusted image extent, accounting for multiplane image factors
4899 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
4900 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
4901 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
4902 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004903 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
4904 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
4905 "zero or <= image subresource width (%d).",
4906 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
4907 adusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004908 }
4909
4910 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
4911 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
4912 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004913 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
4914 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
4915 "zero or <= image subresource height (%d).",
4916 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
4917 adusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004918 }
4919
4920 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
4921 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
4922 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004923 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
4924 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
4925 "zero or <= image subresource depth (%d).",
4926 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
4927 adusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004928 }
4929
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004930 // subresource aspectMask must have exactly 1 bit set
4931 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4932 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4933 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004934 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
4935 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004936 }
4937
4938 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004939 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004940 skip |= LogError(
4941 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004942 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4943 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004944 }
4945
4946 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004947 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004948 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004949
4950 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004951 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004952 skip |= LogError(
4953 image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004954 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4955 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004956 }
4957
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004958 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004959 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004960 skip |= LogError(
4961 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004962 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4963 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004964 }
4965
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004966 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004967 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4968 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4969 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004970 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00205",
4971 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4972 "width & height (%d, %d)..",
4973 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
4974 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004975 }
4976
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004977 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004978 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004979 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004980 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-bufferOffset-00206",
4981 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
4982 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
4983 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004984 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004985
4986 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004987 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004988 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004989 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004990 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00207",
4991 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
4992 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
4993 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
4994 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004995 }
4996
4997 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004998 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004999 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005000 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00208",
5001 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5002 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5003 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5004 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005005 }
5006
5007 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005008 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005009 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005010 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageExtent-00209",
5011 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5012 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5013 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5014 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005015 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005016 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005017
5018 // Checks that apply only to multi-planar format images
5019 if (FormatIsMultiplane(image_state->createInfo.format)) {
5020 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5021 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5022 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005023 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5024 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5025 "format has three planes.",
5026 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005027 }
5028
5029 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5030 if (0 == (pRegions[i].imageSubresource.aspectMask &
5031 (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 -07005032 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5033 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5034 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5035 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005036 }
5037 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005038 }
5039
5040 return skip;
5041}
5042
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005043bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5044 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005045 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005046 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005047
5048 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005049 VkExtent3D extent = pRegions[i].imageExtent;
5050 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005051
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005052 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5053 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005054 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5055 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5056 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005057 }
5058
5059 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5060
5061 // 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 -06005062 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005063 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005064 if (image_extent.width % block_extent.width) {
5065 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5066 }
5067 if (image_extent.height % block_extent.height) {
5068 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5069 }
5070 if (image_extent.depth % block_extent.depth) {
5071 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5072 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005073 }
5074
Dave Houltonfc1a4052017-04-27 14:32:45 -06005075 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005076 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005077 }
5078 }
5079
5080 return skip;
5081}
5082
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005083bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5084 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005085 bool skip = false;
5086
5087 VkDeviceSize buffer_size = buff_state->createInfo.size;
5088
5089 for (uint32_t i = 0; i < regionCount; i++) {
5090 VkExtent3D copy_extent = pRegions[i].imageExtent;
5091
5092 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5093 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005094 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5095 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005096
Tom Cooperb2550c72018-10-15 13:08:41 +01005097 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005098 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005099 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005100 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5101 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5102
5103 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5104 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5105 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005106 }
5107
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005108 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5109 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5110 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005111 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005112 } else {
5113 // Calculate buffer offset of final copied byte, + 1.
5114 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5115 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5116 max_buffer_offset *= unit_size; // convert to bytes
5117 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005118
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005119 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005120 skip |= LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i,
5121 buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005122 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005123 }
5124 }
5125
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005126 return skip;
5127}
5128
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005129bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005130 VkBuffer dstBuffer, uint32_t regionCount,
5131 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005132 const auto cb_node = GetCBState(commandBuffer);
5133 const auto src_image_state = GetImageState(srcImage);
5134 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005135
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005136 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005137
5138 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005139 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005140
5141 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005142 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005143
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005144 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005145
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005146 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005147 skip |=
5148 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5149 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5150 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005151 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005152 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005153 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005154 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005155 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005156
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005157 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005158 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005159 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5160 skip |=
5161 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005162
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005163 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005164 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005165 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5166 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005167 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005168 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5169 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005170 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005171 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5172 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005173 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005174 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005175 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005176 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005177 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5178 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5179 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005180 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005181 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005182 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005183 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005184 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5185 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005186 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5187 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5188 skip |=
5189 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5190 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5191 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005192 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5193 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005194 }
5195 return skip;
5196}
5197
John Zulauf1686f232019-07-09 16:27:11 -06005198void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5199 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5200 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5201
5202 auto cb_node = GetCBState(commandBuffer);
5203 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005204 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005205 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005206 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005207 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005208}
5209
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005210bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5211 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005212 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005213 const auto cb_node = GetCBState(commandBuffer);
5214 const auto src_buffer_state = GetBufferState(srcBuffer);
5215 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005216
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005217 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005218
5219 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005220 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005221
5222 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005223 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005224 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005225 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005226 skip |=
5227 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5228 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5229 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005230 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005231 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005232 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005233 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005234 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005235 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005236 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005237 skip |=
5238 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5239 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005240 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005241 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5242 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005243 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005244 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5245 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005246 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005247 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5248 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005249 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005250 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005251 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005252 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005253 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5254 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5255 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005256 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005257 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005258 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005259 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005260 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5261 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005262 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5263 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5264 skip |=
5265 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5266 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5267 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005268 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5269 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005270 }
5271 return skip;
5272}
5273
John Zulauf1686f232019-07-09 16:27:11 -06005274void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5275 VkImageLayout dstImageLayout, uint32_t regionCount,
5276 const VkBufferImageCopy *pRegions) {
5277 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5278
5279 auto cb_node = GetCBState(commandBuffer);
5280 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005281 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005282 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005283 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005284 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005285}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005286
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005287bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005288 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005289 bool skip = false;
5290 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5291
Dave Houlton1d960ff2018-01-19 12:17:05 -07005292 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005293 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5294 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5295 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005296 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5297 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005298 }
5299
John Zulaufa26d3c82019-08-14 16:09:08 -06005300 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005301 if (!image_entry) {
5302 return skip;
5303 }
5304
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005305 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5306 if (device_extensions.vk_ext_image_drm_format_modifier) {
5307 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5308 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005309 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5310 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5311 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005312 }
5313 } else {
5314 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005315 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5316 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005317 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005318 }
5319
Dave Houlton1d960ff2018-01-19 12:17:05 -07005320 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005321 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005322 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5323 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5324 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005325 }
5326
Dave Houlton1d960ff2018-01-19 12:17:05 -07005327 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005328 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005329 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5330 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5331 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005332 }
5333
Dave Houlton1d960ff2018-01-19 12:17:05 -07005334 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005335 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005336 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5337 if (FormatIsMultiplane(img_format)) {
5338 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5339 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5340 if (FormatPlaneCount(img_format) > 2u) {
5341 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5342 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5343 }
5344 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005345 skip |= LogError(image, vuid,
5346 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5347 ") must be a single-plane specifier flag.",
5348 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005349 }
5350 } else if (FormatIsColor(img_format)) {
5351 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005352 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5353 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5354 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005355 }
5356 } else if (FormatIsDepthOrStencil(img_format)) {
5357 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5358 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005359 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005360 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5361 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5362 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5363 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005364 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5365 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5366 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005367 }
5368 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005369
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005370 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005371 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005372 }
5373
Mike Weiblen672b58b2017-02-21 14:32:53 -07005374 return skip;
5375}