blob: 1271a0330da1c06de6305cc585aafcae96814c18 [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 MakeImageFullRange(const VkImageCreateInfo &create_info) {
53 const auto format = create_info.format;
54 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
55 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
56 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
57 } else {
58 init_range.aspectMask =
59 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
60 }
61 return NormalizeSubresourceRange(create_info, init_range);
62}
63
locke-lunarg296a3c92020-03-25 01:04:29 -060064IMAGE_STATE::IMAGE_STATE(VkDevice dev, VkImage img, const VkImageCreateInfo *pCreateInfo)
John Zulauff660ad62019-03-23 07:16:05 -060065 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -070066 safe_create_info(pCreateInfo),
67 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -060068 valid(false),
69 acquired(false),
70 shared_presentable(false),
71 layout_locked(false),
72 get_sparse_reqs_called(false),
73 sparse_metadata_required(false),
74 sparse_metadata_bound(false),
John Zulauff660ad62019-03-23 07:16:05 -060075 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -070076 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -060077 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -070078 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -060079 create_from_swapchain(VK_NULL_HANDLE),
80 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -060081 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -070082 range_encoder(full_range),
sfricke-samsung71bc6572020-04-29 15:49:43 -070083 disjoint(false),
84 plane0_memory_requirements_checked(false),
85 plane1_memory_requirements_checked(false),
86 plane2_memory_requirements_checked(false),
locke-lunarg296a3c92020-03-25 01:04:29 -060087 subresource_encoder(full_range),
locke-lunargae26eac2020-04-16 15:29:05 -060088 fragment_encoder(nullptr),
locke-lunarg296a3c92020-03-25 01:04:29 -060089 store_device_as_workaround(dev), // TODO REMOVE WHEN encoder can be const
unknown08c57af2019-06-21 16:33:35 -060090 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060091 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
92 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
93 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
94 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
95 }
96 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
97 }
98
99 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
100 sparse = true;
101 }
Locked8af3732019-05-10 09:47:56 -0600102
sfricke-samsunge2441192019-11-06 14:07:57 -0800103 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
104 if (externalMemoryInfo) {
105 external_memory_handle = externalMemoryInfo->handleTypes;
106 }
John Zulauff660ad62019-03-23 07:16:05 -0600107}
108
unknown2c877272019-07-11 12:56:50 -0600109bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
110 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
111 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
112 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
113 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
114 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
115 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600116 return is_equal &&
117 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600118}
119
Jeff Bolz82f854d2019-09-17 14:56:47 -0500120// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
121bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
122 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
123 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
124 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
125 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
126 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600127 is_compatible = is_compatible &&
128 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
129 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500130
131 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
132 createInfo.extent.height <= other_createInfo.extent.height &&
133 createInfo.extent.depth <= other_createInfo.extent.depth &&
134 createInfo.arrayLayers <= other_createInfo.arrayLayers;
135 return is_compatible;
136}
137
unknown2c877272019-07-11 12:56:50 -0600138bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700139 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
140 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
141 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)),
locke-lunarg296a3c92020-03-25 01:04:29 -0600157 range_generator(im->subresource_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
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500184bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700185 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700186 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700187
John Zulauf2076e812020-01-08 14:55:54 -0700188 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
189 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700190 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
191 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
192
John Zulauf2076e812020-01-08 14:55:54 -0700193 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
194
195 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
196 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700197 return false;
198 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700199
John Zulauf2076e812020-01-08 14:55:54 -0700200 for (auto entry : *layout_range_map) {
201 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700202 }
203 return true;
204}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700205
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600206// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600207void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600208 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
209 VkImageLayout expected_layout) {
210 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
211 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600212 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600213 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700214 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700215 for (const auto &image : image_state.aliasing_images) {
216 auto alias_state = GetImageState(image);
217 // The map state of the aliases should all be in sync, so no need to check the return value
218 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
219 assert(subresource_map);
220 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
221 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700222}
John Zulauff660ad62019-03-23 07:16:05 -0600223
224// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600225void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600226 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500227 return;
228 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500229 IMAGE_STATE *image_state = view_state.image_state.get();
230 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700231 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700232 for (const auto &image : image_state->aliasing_images) {
233 image_state = GetImageState(image);
234 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
235 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
236 }
John Zulauff660ad62019-03-23 07:16:05 -0600237}
238
239// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600240void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600241 const VkImageSubresourceRange &range, VkImageLayout layout) {
242 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
243 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600244 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700245 for (const auto &image : image_state.aliasing_images) {
246 auto alias_state = GetImageState(image);
247 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
248 assert(subresource_map);
249 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
250 }
John Zulauff660ad62019-03-23 07:16:05 -0600251}
252
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600253void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600254 VkImageLayout layout) {
255 const IMAGE_STATE *image_state = GetImageState(image);
256 if (!image_state) return;
257 SetImageInitialLayout(cb_node, *image_state, range, layout);
258};
259
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600260void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600261 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
262 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600263}
Dave Houltonddd65c52018-05-08 14:58:01 -0600264
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600265// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700266void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
267 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500268 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600269
John Zulauff660ad62019-03-23 07:16:05 -0600270 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600271 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
272 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600273 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 -0600274 sub_range.baseArrayLayer = 0;
275 sub_range.layerCount = image_state->createInfo.extent.depth;
276 }
277
Piers Daniell4fde9b72019-11-27 16:19:46 -0700278 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
279 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
280 SetImageLayout(cb_node, *image_state, sub_range, layout);
281 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
282 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
283 } else {
284 SetImageLayout(cb_node, *image_state, sub_range, layout);
285 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600286}
287
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700288bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
289 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700290 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600291 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100292 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700293 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100294 const char *vuid;
295 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700296 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100297
298 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600299 LogObjectList objlist(image);
300 objlist.add(renderpass);
301 objlist.add(framebuffer);
302 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700303 skip |=
304 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
305 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
306 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
307 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100308 return skip;
309 }
310
311 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200312 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
313 if (stencil_usage_info) {
314 image_usage |= stencil_usage_info->stencilUsage;
315 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100316
317 // Check for layouts that mismatch image usages in the framebuffer
318 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800319 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600320 LogObjectList objlist(image);
321 objlist.add(renderpass);
322 objlist.add(framebuffer);
323 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700324 skip |= LogError(objlist, vuid,
325 "%s: Layout/usage mismatch for attachment %u in %s"
326 " - the %s is %s but the image attached to %s via %s"
327 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
328 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
329 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
330 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100331 }
332
333 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
334 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800335 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600336 LogObjectList objlist(image);
337 objlist.add(renderpass);
338 objlist.add(framebuffer);
339 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700340 skip |= LogError(objlist, vuid,
341 "%s: Layout/usage mismatch for attachment %u in %s"
342 " - the %s is %s but the image attached to %s via %s"
343 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
344 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
345 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
346 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100347 }
348
349 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800350 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600351 LogObjectList objlist(image);
352 objlist.add(renderpass);
353 objlist.add(framebuffer);
354 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700355 skip |= LogError(objlist, vuid,
356 "%s: 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_TRANSFER_SRC_BIT",
359 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
360 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
361 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100362 }
363
364 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800365 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600366 LogObjectList objlist(image);
367 objlist.add(renderpass);
368 objlist.add(framebuffer);
369 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700370 skip |= LogError(objlist, vuid,
371 "%s: Layout/usage mismatch for attachment %u in %s"
372 " - the %s is %s but the image attached to %s via %s"
373 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
374 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
375 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
376 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100377 }
378
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600379 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100380 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
381 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
382 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
383 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
384 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800385 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600386 LogObjectList objlist(image);
387 objlist.add(renderpass);
388 objlist.add(framebuffer);
389 objlist.add(image_view);
390 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700391 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700392 " - the %s is %s but the image attached to %s via %s"
393 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700394 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700395 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
396 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100397 }
398 } else {
399 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
400 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
401 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
402 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600403 LogObjectList objlist(image);
404 objlist.add(renderpass);
405 objlist.add(framebuffer);
406 objlist.add(image_view);
407 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700408 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700409 " - the %s is %s but the image attached to %s via %s"
410 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700411 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700412 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
413 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100414 }
415 }
416 return skip;
417}
418
John Zulauf17a01bb2019-08-09 16:41:19 -0600419bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700420 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600421 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600422 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700423 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700424 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100425 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100426
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700427 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100428 auto framebuffer = framebuffer_state->framebuffer;
429
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700430 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700431 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
432 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700433 }
John Zulauf8e308292018-09-21 11:34:37 -0600434
Tobias Hectorc9057422019-07-23 12:15:52 +0100435 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
436 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
437 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100438 }
439
Tobias Hectorc9057422019-07-23 12:15:52 +0100440 if (attachments != nullptr) {
441 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
442 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
443 auto image_view = attachments[i];
444 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100445
Tobias Hectorc9057422019-07-23 12:15:52 +0100446 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600447 LogObjectList objlist(pRenderPassBegin->renderPass);
448 objlist.add(framebuffer_state->framebuffer);
449 objlist.add(image_view);
450 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700451 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
452 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
453 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100454 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100455 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100456
457 const VkImage image = view_state->create_info.image;
458 const IMAGE_STATE *image_state = GetImageState(image);
459
460 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600461 LogObjectList objlist(pRenderPassBegin->renderPass);
462 objlist.add(framebuffer_state->framebuffer);
463 objlist.add(image_view);
464 objlist.add(image);
465 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700466 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
467 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
468 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100469 continue;
470 }
471 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
472 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
473
Piers Daniell7f894f62020-01-09 16:33:48 -0700474 // Default to expecting stencil in the same layout.
475 auto attachment_stencil_initial_layout = attachment_initial_layout;
476
477 // If a separate layout is specified, look for that.
478 const auto *attachment_description_stencil_layout =
479 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
480 if (attachment_description_stencil_layout) {
481 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
482 }
483
Tobias Hectorc9057422019-07-23 12:15:52 +0100484 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
485 // in common with the non-const version.)
486 const ImageSubresourceLayoutMap *subresource_map =
487 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
488
489 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
490 LayoutUseCheckAndMessage layout_check(subresource_map);
491 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700492 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
493 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
494 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700495
John Zulauf5e617452019-11-19 14:44:16 -0700496 // Allow for differing depth and stencil layouts
497 VkImageLayout check_layout = attachment_initial_layout;
498 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
499
500 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700501 subres_skip |= LogError(
502 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700503 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
504 "and the %s layout of the attachment is %s. The layouts must match, or the render "
505 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700506 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100507 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700508 }
John Zulauf5e617452019-11-19 14:44:16 -0700509
Tobias Hectorc9057422019-07-23 12:15:52 +0100510 skip |= subres_skip;
511 }
512
513 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
514 framebuffer, render_pass, i, "initial layout");
515
516 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
517 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100518 }
519
Tobias Hectorc9057422019-07-23 12:15:52 +0100520 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
521 auto &subpass = pRenderPassInfo->pSubpasses[j];
522 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
523 auto &attachment_ref = subpass.pInputAttachments[k];
524 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
525 auto image_view = attachments[attachment_ref.attachment];
526 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100527
Tobias Hectorc9057422019-07-23 12:15:52 +0100528 if (view_state) {
529 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700530 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
531 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100532 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100533 }
534 }
535 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100536
Tobias Hectorc9057422019-07-23 12:15:52 +0100537 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
538 auto &attachment_ref = subpass.pColorAttachments[k];
539 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
540 auto image_view = attachments[attachment_ref.attachment];
541 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100542
Tobias Hectorc9057422019-07-23 12:15:52 +0100543 if (view_state) {
544 auto image = view_state->create_info.image;
545 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
546 framebuffer, render_pass, attachment_ref.attachment,
547 "color attachment layout");
548 if (subpass.pResolveAttachments) {
549 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
550 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
551 attachment_ref.attachment, "resolve attachment layout");
552 }
553 }
554 }
555 }
556
557 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
558 auto &attachment_ref = *subpass.pDepthStencilAttachment;
559 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
560 auto image_view = attachments[attachment_ref.attachment];
561 auto view_state = GetImageViewState(image_view);
562
563 if (view_state) {
564 auto image = view_state->create_info.image;
565 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
566 framebuffer, render_pass, attachment_ref.attachment,
567 "input attachment layout");
568 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100569 }
570 }
571 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700572 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600573 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700574}
575
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600576void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700577 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700578 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700579 IMAGE_VIEW_STATE *image_view = nullptr;
580 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
581 const auto attachment_info =
582 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
583 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
584 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300585 image_view = GetAttachmentImageViewState(pCB, pFramebuffer, ref.attachment);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700586 }
John Zulauf8e308292018-09-21 11:34:37 -0600587 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700588 VkImageLayout stencil_layout = kInvalidLayout;
589 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
590 if (attachment_reference_stencil_layout) {
591 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
592 }
593
594 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600595 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700596 }
597}
598
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600599void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
600 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700601 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700602
603 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700604 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700605 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700606 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700607 }
608 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700609 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700610 }
611 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700612 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700613 }
614 }
615}
616
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700617// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
618// 1. Transition into initialLayout state
619// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600620void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700621 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700622 // First transition into initialLayout
623 auto const rpci = render_pass_state->createInfo.ptr();
624 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700625 IMAGE_VIEW_STATE *view_state = nullptr;
626 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
627 const auto attachment_info =
628 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
629 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
630 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300631 view_state = GetAttachmentImageViewState(cb_state, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700632 }
John Zulauf8e308292018-09-21 11:34:37 -0600633 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700634 VkImageLayout stencil_layout = kInvalidLayout;
635 const auto *attachment_description_stencil_layout =
636 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
637 if (attachment_description_stencil_layout) {
638 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
639 }
640
641 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600642 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700643 }
644 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700645 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700646}
647
Dave Houlton10b39482017-03-16 13:18:15 -0600648bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600649 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600650 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600651 }
652 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600653 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600654 }
655 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600656 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600657 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700658 if (0 !=
659 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
660 if (FormatPlaneCount(format) == 1) return false;
661 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600662 return true;
663}
664
Mike Weiblen62d08a32017-03-07 22:18:27 -0700665// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200666bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
667 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600668 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700669 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200670 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600671 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700672
673 switch (layout) {
674 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
675 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600676 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700677 }
678 break;
679 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
680 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600681 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700682 }
683 break;
684 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
685 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600686 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700687 }
688 break;
689 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
690 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600691 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700692 }
693 break;
694 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
695 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600696 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700697 }
698 break;
699 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
700 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600701 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700702 }
703 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600704 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500705 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
706 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
707 }
708 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700709 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
710 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
711 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
712 }
713 break;
714 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
715 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
716 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
717 }
718 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700719 default:
720 // Other VkImageLayout values do not have VUs defined in this context.
721 break;
722 }
723
Dave Houlton8e9f6542018-05-18 12:18:22 -0600724 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700725 skip |= LogError(img_barrier.image, msg_code,
726 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
727 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
728 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700729 }
730 return skip;
731}
732
733// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600734bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
735 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700736 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700737
Petr Krausad0096a2019-08-09 18:35:04 +0200738 // Scoreboard for checking for duplicate and inconsistent barriers to images
739 struct ImageBarrierScoreboardEntry {
740 uint32_t index;
741 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
742 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
743 const VkImageMemoryBarrier *barrier;
744 };
745 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
746 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
747
John Zulauf463c51e2018-05-31 13:29:20 -0600748 // Scoreboard for duplicate layout transition barriers within the list
749 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
750 ImageBarrierScoreboardImageMap layout_transitions;
751
Mike Weiblen62d08a32017-03-07 22:18:27 -0700752 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200753 const auto &img_barrier = pImageMemoryBarriers[i];
754 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700755
John Zulauf463c51e2018-05-31 13:29:20 -0600756 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
757 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
758 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200759 if (img_barrier.oldLayout != img_barrier.newLayout) {
760 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
761 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600762 if (image_it != layout_transitions.end()) {
763 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200764 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600765 if (subres_it != subres_map.end()) {
766 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200767 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
768 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
769 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700770 skip = LogError(
771 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200772 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600773 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
774 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200775 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
776 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
777 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600778 }
779 entry = new_entry;
780 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200781 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600782 }
783 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200784 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600785 }
786 }
787
Petr Krausad0096a2019-08-09 18:35:04 +0200788 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600789 if (image_state) {
790 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200791 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
792 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600793
794 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
795 if (image_state->layout_locked) {
796 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700797 skip |= LogError(
798 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700799 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600800 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700801 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200802 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600803 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600804
John Zulaufa4472282019-08-22 14:44:34 -0600805 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700806 const VkFormat image_format = image_create_info.format;
807 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600808 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700809 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700810 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600811 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
812 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700813 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
814 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
815 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
816 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700817 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600818 }
819 } else {
820 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
821 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -0700822 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
823 ? "VUID-VkImageMemoryBarrier-image-03320"
824 : "VUID-VkImageMemoryBarrier-image-01207";
825 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700826 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
827 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
828 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700829 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600830 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700831 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700832 }
John Zulauff660ad62019-03-23 07:16:05 -0600833
Petr Krausad0096a2019-08-09 18:35:04 +0200834 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
835 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600836 // TODO: Set memory invalid which is in mem_tracker currently
837 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
838 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600839 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600840 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600841 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200842 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700843 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
844 const auto &value = *pos;
845 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700846 subres_skip = LogError(
847 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700848 "%s: For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
John Zulauf5e617452019-11-19 14:44:16 -0700849 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700850 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -0700851 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
852 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600853 }
John Zulauf5e617452019-11-19 14:44:16 -0700854 }
John Zulauff660ad62019-03-23 07:16:05 -0600855 skip |= subres_skip;
856 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700857
858 // checks color format and (single-plane or non-disjoint)
859 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
860 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700861 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700862 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
863 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
864 ? "VUID-VkImageMemoryBarrier-image-01671"
865 : "VUID-VkImageMemoryBarrier-image-02902";
866 skip |= LogError(img_barrier.image, vuid,
867 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
868 "but its aspectMask is 0x%" PRIx32 ".",
869 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
870 string_VkFormat(image_format), aspect_mask);
871 }
872 }
873
874 VkImageAspectFlags valid_disjoint_mask =
875 VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT | VK_IMAGE_ASPECT_COLOR_BIT;
sfricke-samsung71bc6572020-04-29 15:49:43 -0700876 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700877 ((aspect_mask & valid_disjoint_mask) == 0)) {
878 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
879 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
880 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
881 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
882 string_VkFormat(image_format), aspect_mask);
883 }
884
885 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
886 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
887 "%s: Image barrier %s references %s of format %s has only two planes but included "
888 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
889 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
890 string_VkFormat(image_format), aspect_mask);
891 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700892 }
893 }
894 return skip;
895}
896
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600897bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200898 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700899
Jeff Bolz6835fda2019-10-06 00:15:34 -0500900 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200901 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700902}
903
John Zulauf6b4aae82018-05-09 13:03:36 -0600904template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600905bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
906 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600907 using BarrierRecord = QFOTransferBarrier<Barrier>;
908 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500909 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600910 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
911 const char *barrier_name = BarrierRecord::BarrierName();
912 const char *handle_name = BarrierRecord::HandleName();
913 const char *transfer_type = nullptr;
914 for (uint32_t b = 0; b < barrier_count; b++) {
915 if (!IsTransferOp(&barriers[b])) continue;
916 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700917 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600918 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600919 const auto found = barrier_sets.release.find(barriers[b]);
920 if (found != barrier_sets.release.cend()) {
921 barrier_record = &(*found);
922 transfer_type = "releasing";
923 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600924 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600925 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600926 const auto found = barrier_sets.acquire.find(barriers[b]);
927 if (found != barrier_sets.acquire.cend()) {
928 barrier_record = &(*found);
929 transfer_type = "acquiring";
930 }
931 }
932 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700933 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
934 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
935 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
936 func_name, barrier_name, b, transfer_type, handle_name,
937 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
938 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600939 }
940 }
941 return skip;
942}
943
John Zulaufa4472282019-08-22 14:44:34 -0600944VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
945 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
946}
947
948const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
949 return device_state.GetImageState(barrier.image);
950}
951
952VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
953 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
954}
955
956const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
957 return device_state.GetBufferState(barrier.buffer);
958}
959
960VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
961
John Zulauf6b4aae82018-05-09 13:03:36 -0600962template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600963void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
964 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500965 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600966 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
967 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600968 auto &barrier = barriers[b];
969 if (IsTransferOp(&barrier)) {
970 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600971 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -0600972 barrier_sets.release.emplace(barrier);
973 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600974 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -0600975 barrier_sets.acquire.emplace(barrier);
976 }
977 }
978
979 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
980 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
981 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
982 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
983 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
984 auto handle_state = BarrierHandleState(*this, barrier);
985 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
986 if (!mode_concurrent) {
987 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -0500988 cb_state->queue_submit_functions.emplace_back(
989 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
990 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
991 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
992 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -0600993 });
994 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600995 }
996 }
997}
998
John Zulaufa4472282019-08-22 14:44:34 -0600999bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001000 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001001 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001002 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001003 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001004 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1005 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001006 return skip;
1007}
1008
John Zulaufa4472282019-08-22 14:44:34 -06001009void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1010 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1011 const VkImageMemoryBarrier *pImageMemBarriers) {
1012 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1013 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001014}
1015
1016template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001017bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001018 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001019 // Record to the scoreboard or report that we have a duplication
1020 bool skip = false;
1021 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1022 if (!inserted.second && inserted.first->second != cb_state) {
1023 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
Mark Lobodzinskiea561582020-03-16 18:13:56 -06001024 LogObjectList objlist(cb_state->commandBuffer);
1025 objlist.add(barrier.handle);
1026 objlist.add(inserted.first->second->commandBuffer);
1027 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001028 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1029 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1030 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1031 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1032 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001033 }
1034 return skip;
1035}
1036
1037template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001038bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1039 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001040 using BarrierRecord = QFOTransferBarrier<Barrier>;
1041 using TypeTag = typename BarrierRecord::Tag;
1042 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001043 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001044 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001045 const char *barrier_name = BarrierRecord::BarrierName();
1046 const char *handle_name = BarrierRecord::HandleName();
1047 // No release should have an extant duplicate (WARNING)
1048 for (const auto &release : cb_barriers.release) {
1049 // Check the global pending release barriers
1050 const auto set_it = global_release_barriers.find(release.handle);
1051 if (set_it != global_release_barriers.cend()) {
1052 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1053 const auto found = set_for_handle.find(release);
1054 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001055 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1056 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1057 " to dstQueueFamilyIndex %" PRIu32
1058 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1059 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1060 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001061 }
1062 }
1063 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1064 }
1065 // Each acquire must have a matching release (ERROR)
1066 for (const auto &acquire : cb_barriers.acquire) {
1067 const auto set_it = global_release_barriers.find(acquire.handle);
1068 bool matching_release_found = false;
1069 if (set_it != global_release_barriers.cend()) {
1070 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1071 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1072 }
1073 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001074 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1075 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1076 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1077 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1078 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001079 }
1080 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1081 }
1082 return skip;
1083}
1084
John Zulauf3b04ebd2019-07-18 14:08:11 -06001085bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001086 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001087 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001088 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001089 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1090 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001091 return skip;
1092}
1093
1094template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001095void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001096 using BarrierRecord = QFOTransferBarrier<Barrier>;
1097 using TypeTag = typename BarrierRecord::Tag;
1098 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001099 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001100
1101 // Add release barriers from this submit to the global map
1102 for (const auto &release : cb_barriers.release) {
1103 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1104 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1105 global_release_barriers[release.handle].insert(release);
1106 }
1107
1108 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1109 for (const auto &acquire : cb_barriers.acquire) {
1110 // NOTE: We're not using [] because we don't want to create entries for missing releases
1111 auto set_it = global_release_barriers.find(acquire.handle);
1112 if (set_it != global_release_barriers.end()) {
1113 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1114 set_for_handle.erase(acquire);
1115 if (set_for_handle.size() == 0) { // Clean up empty sets
1116 global_release_barriers.erase(set_it);
1117 }
1118 }
1119 }
1120}
1121
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001122void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001123 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1124 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001125}
1126
John Zulauf6b4aae82018-05-09 13:03:36 -06001127// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001128void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001129
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001130void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001131 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001132 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001133 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001134
Chris Forbes4de4b132017-08-21 11:27:08 -07001135 // For ownership transfers, the barrier is specified twice; as a release
1136 // operation on the yielding queue family, and as an acquire operation
1137 // on the acquiring queue family. This barrier may also include a layout
1138 // transition, which occurs 'between' the two operations. For validation
1139 // purposes it doesn't seem important which side performs the layout
1140 // transition, but it must not be performed twice. We'll arbitrarily
1141 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001142 //
1143 // However, we still need to record initial layout for the "initial layout" validation
1144 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001145
Petr Krausad0096a2019-08-09 18:35:04 +02001146 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001147 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001148 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001149 }
1150}
1151
unknown86bcb3a2019-07-11 13:05:36 -06001152void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001153 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001154 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1155 const auto &image_create_info = image_state->createInfo;
1156
1157 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1158 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1159 // for all (potential) layer sub_resources.
1160 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1161 normalized_isr.baseArrayLayer = 0;
1162 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1163 }
1164
Michael Spang8af7c102020-05-03 20:50:09 -04001165 VkImageLayout initial_layout = mem_barrier.oldLayout;
1166
1167 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001168 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001169 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1170 }
1171
John Zulauf2be3fe02019-12-30 09:48:02 -07001172 if (is_release_op) {
1173 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1174 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001175 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001176 }
unknown86bcb3a2019-07-11 13:05:36 -06001177}
1178
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001179bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1180 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1181 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1182 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001183 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001184 assert(cb_node);
1185 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001186 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001187 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001188
John Zulauff660ad62019-03-23 07:16:05 -06001189 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1190 if (subresource_map) {
1191 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001192 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001193 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1194 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001195 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001196 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1197 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1198 "%s layout %s.",
1199 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1200 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1201 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001202 }
John Zulauf5e617452019-11-19 14:44:16 -07001203 }
John Zulauff660ad62019-03-23 07:16:05 -06001204 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001205 }
John Zulauff660ad62019-03-23 07:16:05 -06001206
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001207 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1208 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1209 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001210 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1211 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001212 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1213 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1214 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001215 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001216 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001217 if (image_state->shared_presentable) {
1218 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001219 skip |=
1220 LogError(device, layout_invalid_msg_code,
1221 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1222 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001223 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001224 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001225 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001226 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001227 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1228 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1229 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1230 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001231 }
1232 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001233 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001234}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001235bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001236 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1237 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001238 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001239 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1240 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1241}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001242
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001243void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001244 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001245 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001246 if (!renderPass) return;
1247
Tobias Hectorbbb12282018-10-22 15:17:59 +01001248 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001249 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001250 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001251 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001252 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1253 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1254 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1255 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001256 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001257 }
John Zulauf8e308292018-09-21 11:34:37 -06001258 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001259 VkImageLayout stencil_layout = kInvalidLayout;
1260 const auto *attachment_description_stencil_layout =
1261 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1262 if (attachment_description_stencil_layout) {
1263 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1264 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001265 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001266 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001267 }
1268 }
1269}
Dave Houltone19e20d2018-02-02 16:32:41 -07001270
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001271#ifdef VK_USE_PLATFORM_ANDROID_KHR
1272// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1273// This could also move into a seperate core_validation_android.cpp file... ?
1274
1275//
1276// AHB-specific validation within non-AHB APIs
1277//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001278bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001279 bool skip = false;
1280
1281 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1282 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001283 if (0 != ext_fmt_android->externalFormat) {
1284 if (VK_FORMAT_UNDEFINED != create_info->format) {
1285 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001286 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1287 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1288 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001289 }
1290
1291 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001292 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1293 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1294 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001295 }
1296
1297 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001298 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1299 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001300 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1301 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1302 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001303 }
1304
1305 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001306 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1307 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1308 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001309 }
1310 }
1311
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001312 if ((0 != ext_fmt_android->externalFormat) &&
1313 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001314 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001315 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1316 ") which has "
1317 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1318 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001319 }
1320 }
1321
Dave Houltond9611312018-11-19 17:03:36 -07001322 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001323 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001324 skip |=
1325 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1326 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1327 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001328 }
1329 }
1330
1331 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1332 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1333 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001334 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001335 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1336 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1337 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1338 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001339 }
1340
1341 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001342 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1343 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1344 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1345 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1346 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001347 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001348 }
1349
1350 return skip;
1351}
1352
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001353bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001354 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001355 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001356
1357 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001358 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001359 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1360 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001361 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001362 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001363 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001364
Dave Houltond9611312018-11-19 17:03:36 -07001365 // Chain must include a compatible ycbcr conversion
1366 bool conv_found = false;
1367 uint64_t external_format = 0;
1368 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1369 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001370 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001371 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001372 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001373 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001374 }
Dave Houltond9611312018-11-19 17:03:36 -07001375 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001376 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001377 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001378 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1379 "an externalFormat (%" PRIu64
1380 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1381 "with the same external format.",
1382 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001383 }
1384
1385 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001386 if (IsIdentitySwizzle(create_info->components) == false) {
1387 skip |= LogError(
1388 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1389 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1390 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1391 "= %s.",
1392 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1393 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001394 }
1395 }
Dave Houltond9611312018-11-19 17:03:36 -07001396
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001397 return skip;
1398}
1399
John Zulaufa26d3c82019-08-14 16:09:08 -06001400bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001401 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001402
John Zulaufa26d3c82019-08-14 16:09:08 -06001403 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001404 if (image_state != nullptr) {
1405 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1406 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1407 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1408 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1409 "bound to memory.");
1410 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001411 }
1412 return skip;
1413}
1414
1415#else
1416
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001417bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001418 return false;
1419}
1420
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001421bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001422
John Zulaufa26d3c82019-08-14 16:09:08 -06001423bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001424
1425#endif // VK_USE_PLATFORM_ANDROID_KHR
1426
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001427bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1428 bool skip = false;
1429
1430 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1431 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1432 const VkImageTiling image_tiling = pCreateInfo->tiling;
1433 const VkFormat image_format = pCreateInfo->format;
1434
1435 if (image_format == VK_FORMAT_UNDEFINED) {
1436 // VU 01975 states format can't be undefined unless an android externalFormat
1437#ifdef VK_USE_PLATFORM_ANDROID_KHR
1438 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1439 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1440 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1441 if (it != ahb_ext_formats_map.end()) {
1442 tiling_features = it->second;
1443 }
1444 }
1445#endif
1446 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1447 uint64_t drm_format_modifier = 0;
1448 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1449 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1450 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1451 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1452
1453 if (drm_explicit != nullptr) {
1454 drm_format_modifier = drm_explicit->drmFormatModifier;
1455 } else {
1456 // VUID 02261 makes sure its only explict or implict in parameter checking
1457 assert(drm_implicit != nullptr);
1458 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1459 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1460 }
1461 }
1462
1463 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1464 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1465 nullptr};
1466 format_properties_2.pNext = (void *)&drm_properties_list;
1467 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001468 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1469 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1470 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1471 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001472
1473 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1474 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1475 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1476 }
1477 }
1478 } else {
1479 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1480 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1481 : format_properties.optimalTilingFeatures;
1482 }
1483
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001484 // Lack of disjoint format feature support while using the flag
1485 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1486 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1487 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1488 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1489 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1490 string_VkFormat(pCreateInfo->format));
1491 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001492
1493 return skip;
1494}
1495
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001496bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001497 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001498 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001499
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001500 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001501 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001502 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1503 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001504 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1505 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001506 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001507 }
1508
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001509 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1510 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001511 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1512 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1513 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001514 }
1515
1516 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001517 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1518 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1519 "height (%d) and arrayLayers (%d) must be >= 6.",
1520 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001521 }
Dave Houlton130c0212018-01-29 13:39:56 -07001522 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001523
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001524 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001525 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1526 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1527 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001528 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1529 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1530 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001531 }
1532
1533 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001534 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1535 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1536 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001537 }
1538
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001539 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
ByumjinConffx991b6062019-08-14 15:17:53 -07001540 uint32_t ceiling_width =
1541 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1542 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1543 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1544 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001545 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1546 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1547 "ceiling of device "
1548 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1549 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1550 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001551 }
1552
1553 uint32_t ceiling_height =
1554 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1555 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1556 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1557 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001558 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1559 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1560 "ceiling of device "
1561 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1562 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1563 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001564 }
1565 }
1566
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001567 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001568 VkResult result = VK_SUCCESS;
1569 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1570 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1571 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1572 &format_limits);
1573 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001574 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1575 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1576 if (modifier_list) {
1577 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1578 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1579 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1580 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1581 image_format_info.type = pCreateInfo->imageType;
1582 image_format_info.format = pCreateInfo->format;
1583 image_format_info.tiling = pCreateInfo->tiling;
1584 image_format_info.usage = pCreateInfo->usage;
1585 image_format_info.flags = pCreateInfo->flags;
1586 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1587
1588 result =
1589 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1590 format_limits = image_format_properties.imageFormatProperties;
1591
1592 /* The application gives a list of modifier and the driver
1593 * selects one. If one is wrong, stop there.
1594 */
1595 if (result != VK_SUCCESS) break;
1596 }
1597 } else if (explicit_modifier) {
1598 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1599 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1600 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1601 image_format_info.type = pCreateInfo->imageType;
1602 image_format_info.format = pCreateInfo->format;
1603 image_format_info.tiling = pCreateInfo->tiling;
1604 image_format_info.usage = pCreateInfo->usage;
1605 image_format_info.flags = pCreateInfo->flags;
1606 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1607
1608 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1609 format_limits = image_format_properties.imageFormatProperties;
1610 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001611 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001612
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001613 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1614 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1615 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1616 if (result != VK_SUCCESS) {
1617 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001618#ifdef VK_USE_PLATFORM_ANDROID_KHR
1619 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1620#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001621 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001622 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001623 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1624 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001625 } else {
1626 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1627 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001628 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1629 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1630 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001631 }
Dave Houlton130c0212018-01-29 13:39:56 -07001632
Dave Houltona585d132019-01-18 13:05:42 -07001633 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1634 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1635 (uint64_t)pCreateInfo->samples;
1636 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001637
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001638 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001639 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001640 uint64_t ig_mask = imageGranularity - 1;
1641 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001642
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001643 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001644 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1645 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1646 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1647 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001648 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001649
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001650 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001651 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1652 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1653 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001654 }
1655
1656 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001657 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1658 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1659 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001660 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001661
1662 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1663 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1664 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1665 pCreateInfo->extent.width, format_limits.maxExtent.width);
1666 }
1667
1668 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1669 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1670 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1671 pCreateInfo->extent.height, format_limits.maxExtent.height);
1672 }
1673
1674 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1675 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1676 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1677 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1678 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001679 }
1680
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001681 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001682 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1683 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1684 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1685 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001686 skip |= LogError(device, error_vuid,
1687 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1688 "YCbCr Conversion format, arrayLayers must be 1",
1689 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001690 }
1691
1692 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001693 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1694 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1695 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001696 }
1697
1698 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001699 skip |= LogError(
1700 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001701 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1702 string_VkSampleCountFlagBits(pCreateInfo->samples));
1703 }
1704
1705 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001706 skip |= LogError(
1707 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001708 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1709 string_VkImageType(pCreateInfo->imageType));
1710 }
1711 }
1712
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001713 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001714 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001715 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001716 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001717 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1718 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1719 "format must be block, ETC or ASTC compressed, but is %s",
1720 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001721 }
1722 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001723 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1724 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1725 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001726 }
1727 }
1728 }
1729
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001730 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001731 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1732 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1733 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001734 }
1735
unknown2c877272019-07-11 12:56:50 -06001736 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1737 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1738 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001739 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1740 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1741 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001742 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001743
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001744 const auto swapchain_create_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1745 if (swapchain_create_info != nullptr) {
1746 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1747 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1748 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1749
1750 // Validate rest of Swapchain Image create check that require swapchain state
1751 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1752 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1753 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1754 skip |= LogError(
1755 device, vuid,
1756 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1757 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1758 }
1759 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1760 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1761 skip |= LogError(device, vuid,
1762 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1763 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1764 }
1765 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR);
1766 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1767 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1768 skip |= LogError(device, vuid,
1769 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1770 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
1771 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR flags both set.");
1772 }
1773 }
1774 }
1775
sfricke-samsungedce77a2020-07-03 22:35:13 -07001776 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1777 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1778 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1779 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1780 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1781 }
1782 const VkImageCreateFlags invalid_flags =
1783 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1784 if ((pCreateInfo->flags & invalid_flags) != 0) {
1785 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1786 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1787 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1788 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1789 }
1790 }
1791
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001792 skip |= ValidateImageFormatFeatures(pCreateInfo);
1793
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001794 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001795}
1796
John Zulauf7eeb6f72019-06-17 11:56:36 -06001797void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1798 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1799 if (VK_SUCCESS != result) return;
1800
1801 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001802 auto image_state = Get<IMAGE_STATE>(*pImage);
1803 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001804}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001805
Jeff Bolz5c801d12019-10-09 10:38:45 -05001806bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001807 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001808 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001809 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001810 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001811 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001812 }
1813 return skip;
1814}
1815
John Zulauf7eeb6f72019-06-17 11:56:36 -06001816void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1817 // Clean up validation specific data
1818 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001819
locke-lunargcba7d5f2019-12-30 16:59:11 -07001820 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001821
1822 // Clean up generic image state
1823 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001824}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001825
sfricke-samsungcd924d92020-05-20 23:51:17 -07001826bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
1827 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001828 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07001829 const VkImage image = image_state->image;
1830 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001831
1832 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001833 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
1834 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001835 }
1836
sfricke-samsungcd924d92020-05-20 23:51:17 -07001837 if (FormatIsDepthOrStencil(format)) {
1838 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1839 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
1840 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
1841 } else if (FormatIsCompressed(format)) {
1842 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1843 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
1844 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001845 }
1846
1847 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001848 skip |=
1849 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
1850 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
1851 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001852 }
1853 return skip;
1854}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001855
John Zulauf07288512019-07-05 11:09:50 -06001856bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1857 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1858 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001859 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001860 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1861 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001862 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1863 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1864 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001865 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001866
1867 } else {
1868 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1869 if (!device_extensions.vk_khr_shared_presentable_image) {
1870 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001871 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1872 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1873 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001874 }
1875 } else {
1876 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1877 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001878 skip |= LogError(
1879 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001880 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1881 func_name, string_VkImageLayout(dest_image_layout));
1882 }
1883 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001884 }
1885
John Zulauff660ad62019-03-23 07:16:05 -06001886 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001887 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001888 if (subresource_map) {
1889 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001890 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001891 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001892 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1893 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001894 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1895 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1896 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1897 } else {
1898 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001899 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001900 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1901 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1902 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1903 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001904 }
John Zulauf5e617452019-11-19 14:44:16 -07001905 }
John Zulauff660ad62019-03-23 07:16:05 -06001906 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001907 }
1908
1909 return skip;
1910}
1911
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001912bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1913 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001914 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001915 bool skip = false;
1916 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001917 const auto *cb_node = GetCBState(commandBuffer);
1918 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001919 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001920 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001921 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001922 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001923 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001924 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001925 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1926 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001927 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001928 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001929 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001930 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001931 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07001932 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001933 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001934 }
sfricke-samsunge775d492020-02-28 09:02:25 -08001935 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
1936 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
1937 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
1938 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
1939 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
1940 string_VkFormat(image_state->createInfo.format));
1941 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001942 }
1943 return skip;
1944}
1945
John Zulaufeabb4462019-07-05 14:13:03 -06001946void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1947 const VkClearColorValue *pColor, uint32_t rangeCount,
1948 const VkImageSubresourceRange *pRanges) {
1949 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1950
1951 auto cb_node = GetCBState(commandBuffer);
1952 auto image_state = GetImageState(image);
1953 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001954 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001955 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001956 }
1957 }
1958}
1959
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001960bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1961 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001962 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001963 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001964
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001965 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001966 const auto *cb_node = GetCBState(commandBuffer);
1967 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001968 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001969 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001970 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001971 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001972 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001973 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001974 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001975 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001976 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001977 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001978 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001979
1980 bool any_include_aspect_depth_bit = false;
1981 bool any_include_aspect_stencil_bit = false;
1982
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001983 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001984 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001985 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001986 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001987 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001988 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1989 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001990 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
1991 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
1992 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
1993 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001994 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001995 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1996 any_include_aspect_depth_bit = true;
1997 }
1998 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1999 any_include_aspect_stencil_bit = true;
2000 }
2001 }
2002 if (any_include_aspect_stencil_bit) {
2003 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2004 if (image_stencil_struct != nullptr) {
2005 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2006 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002007 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2008 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2009 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2010 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002011 }
2012 } else {
2013 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002014 skip |= LogError(
2015 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002016 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2017 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2018 "in VkImageCreateInfo::usage used to create image");
2019 }
2020 }
2021 }
2022 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002023 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2024 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2025 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002026 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06002027 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002028 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2029 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
2030 report_data->FormatHandle(image).c_str(), string_VkFormat(image_state->createInfo.format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002031 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002032 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002033 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2034 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2035 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2036 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002037 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002038 }
2039 return skip;
2040}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002041
John Zulaufeabb4462019-07-05 14:13:03 -06002042void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2043 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2044 const VkImageSubresourceRange *pRanges) {
2045 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2046 auto cb_node = GetCBState(commandBuffer);
2047 auto image_state = GetImageState(image);
2048 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002049 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002050 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002051 }
2052 }
2053}
2054
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002055// Returns true if [x, xoffset] and [y, yoffset] overlap
2056static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2057 bool result = false;
2058 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2059 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2060
2061 if (intersection_max > intersection_min) {
2062 result = true;
2063 }
2064 return result;
2065}
2066
Dave Houltonc991cc92018-03-06 11:08:51 -07002067// Returns true if source area of first copy region intersects dest area of second region
2068// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2069static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002070 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002071
Dave Houltonc991cc92018-03-06 11:08:51 -07002072 // Separate planes within a multiplane image cannot intersect
2073 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002074 return result;
2075 }
2076
Dave Houltonc991cc92018-03-06 11:08:51 -07002077 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2078 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2079 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002080 result = true;
2081 switch (type) {
2082 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002083 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002084 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002085 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002086 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002087 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002088 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002089 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002090 break;
2091 default:
2092 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2093 assert(false);
2094 }
2095 }
2096 return result;
2097}
2098
Dave Houltonfc1a4052017-04-27 14:32:45 -06002099// Returns non-zero if offset and extent exceed image extents
2100static const uint32_t x_bit = 1;
2101static const uint32_t y_bit = 2;
2102static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002103static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002104 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002105 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002106 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2107 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002108 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002109 }
2110 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2111 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002112 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002113 }
2114 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2115 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002116 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002117 }
2118 return result;
2119}
2120
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002121// Test if two VkExtent3D structs are equivalent
2122static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2123 bool result = true;
2124 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2125 (extent->depth != other_extent->depth)) {
2126 result = false;
2127 }
2128 return result;
2129}
2130
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002131// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002132static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002133 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2134}
2135
2136// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002137VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002138 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2139 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002140 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002141 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002142 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002143 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002144 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002145 granularity.width *= block_size.width;
2146 granularity.height *= block_size.height;
2147 }
2148 }
2149 return granularity;
2150}
2151
2152// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2153static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2154 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002155 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2156 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002157 valid = false;
2158 }
2159 return valid;
2160}
2161
2162// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002163bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002164 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002165 bool skip = false;
2166 VkExtent3D offset_extent = {};
2167 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2168 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2169 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002170 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002171 // 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 -07002172 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002173 skip |= LogError(cb_node->commandBuffer, vuid,
2174 "%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 "
2175 "image transfer granularity is (w=0, h=0, d=0).",
2176 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002177 }
2178 } else {
2179 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2180 // integer multiples of the image transfer granularity.
2181 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002182 skip |= LogError(cb_node->commandBuffer, vuid,
2183 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2184 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2185 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2186 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002187 }
2188 }
2189 return skip;
2190}
2191
2192// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002193bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002194 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002195 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002196 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002197 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002198 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2199 // subresource extent.
2200 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002201 skip |= LogError(cb_node->commandBuffer, vuid,
2202 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2203 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2204 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2205 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002206 }
2207 } else {
2208 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2209 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2210 // subresource extent dimensions.
2211 VkExtent3D offset_extent_sum = {};
2212 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2213 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2214 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002215 bool x_ok = true;
2216 bool y_ok = true;
2217 bool z_ok = true;
2218 switch (image_type) {
2219 case VK_IMAGE_TYPE_3D:
2220 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2221 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002222 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002223 case VK_IMAGE_TYPE_2D:
2224 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2225 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002226 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002227 case VK_IMAGE_TYPE_1D:
2228 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2229 (subresource_extent->width == offset_extent_sum.width));
2230 break;
2231 default:
2232 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2233 assert(false);
2234 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002235 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002236 skip |=
2237 LogError(cb_node->commandBuffer, vuid,
2238 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2239 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2240 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2241 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2242 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2243 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002244 }
2245 }
2246 return skip;
2247}
2248
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002249bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002250 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002251 bool skip = false;
2252 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002253 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2254 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002255 }
2256 return skip;
2257}
2258
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002259bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002260 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002261 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002262 bool skip = false;
2263 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2264 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002265 skip |= LogError(cb_node->commandBuffer, vuid,
2266 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2267 "%u, but provided %s has %u array layers.",
2268 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2269 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002270 }
2271 return skip;
2272}
2273
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002274// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002275bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002276 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002277 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002278 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002279 VkExtent3D granularity = GetScaledItg(cb_node, img);
2280 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002281 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002282 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002283 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002284 return skip;
2285}
2286
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002287// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002288bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002289 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002290 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002291 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002292 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002293 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2294 skip |=
2295 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002296 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002297 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002298 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2299 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002300
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002301 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002302 granularity = GetScaledItg(cb_node, dst_img);
2303 skip |=
2304 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002305 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002306 const VkExtent3D dest_effective_extent =
2307 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002308 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002309 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002310 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002311 return skip;
2312}
2313
Dave Houlton6f9059e2017-05-02 17:15:13 -06002314// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002315bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002316 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002317 bool skip = false;
2318
2319 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002320 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002321
2322 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002323 const VkExtent3D src_copy_extent = region.extent;
2324 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002325 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2326
Dave Houlton6f9059e2017-05-02 17:15:13 -06002327 bool slice_override = false;
2328 uint32_t depth_slices = 0;
2329
2330 // Special case for copying between a 1D/2D array and a 3D image
2331 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2332 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002333 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002334 slice_override = (depth_slices != 1);
2335 } 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 -07002336 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002337 slice_override = (depth_slices != 1);
2338 }
2339
2340 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002341 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002342 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002343 skip |=
2344 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2345 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2346 "be 0 and 1, respectively.",
2347 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002348 }
2349 }
2350
Dave Houlton533be9f2018-03-26 17:08:30 -06002351 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 -07002352 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2353 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2354 "these must be 0 and 1, respectively.",
2355 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002356 }
2357
Dave Houlton533be9f2018-03-26 17:08:30 -06002358 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002359 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2360 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2361 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002362 }
2363
Dave Houltonc991cc92018-03-06 11:08:51 -07002364 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002365 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002366 if (FormatIsCompressed(src_state->createInfo.format) ||
2367 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002368 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002369 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002370 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2371 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2372 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002373 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002374 skip |= LogError(src_state->image, vuid,
2375 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2376 "texel width & height (%d, %d).",
2377 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002378 }
2379
Dave Houlton94a00372017-12-14 15:08:47 -07002380 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002381 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2382 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002383 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002384 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002385 LogError(src_state->image, vuid,
2386 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2387 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2388 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002389 }
2390
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002391 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002392 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2393 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002394 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002395 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002396 LogError(src_state->image, vuid,
2397 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2398 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2399 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002400 }
2401
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002402 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002403 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2404 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002405 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002406 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002407 LogError(src_state->image, vuid,
2408 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2409 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2410 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002411 }
2412 } // Compressed
2413
2414 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002415 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002416 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002417 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2418 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2419 "these must be 0 and 1, respectively.",
2420 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002421 }
2422 }
2423
Dave Houlton533be9f2018-03-26 17:08:30 -06002424 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 -07002425 skip |=
2426 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2427 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2428 "and 1, respectively.",
2429 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002430 }
2431
Dave Houlton533be9f2018-03-26 17:08:30 -06002432 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002433 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2434 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2435 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002436 }
2437
sfricke-samsung30b094c2020-05-30 11:42:11 -07002438 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002439 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002440 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2441 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
2442 skip |=
2443 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2444 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2445 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2446 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2447 }
2448 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002449 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002450 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002451 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002452 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2453 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2454 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2455 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002456 }
2457 }
2458 } else { // Pre maint 1
2459 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002460 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
2461 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00139",
2462 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2463 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2464 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2465 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2466 }
Dave Houltonee281a52017-12-08 13:51:02 -07002467 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002468 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00139",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002469 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2470 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2471 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2472 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002473 }
2474 }
2475 }
2476
Dave Houltonc991cc92018-03-06 11:08:51 -07002477 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2478 if (FormatIsCompressed(dst_state->createInfo.format) ||
2479 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002480 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002481
2482 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002483 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2484 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2485 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002486 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002487 skip |= LogError(dst_state->image, vuid,
2488 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2489 "texel width & height (%d, %d).",
2490 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002491 }
2492
Dave Houlton94a00372017-12-14 15:08:47 -07002493 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002494 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2495 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002496 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002497 skip |= LogError(
2498 dst_state->image, vuid,
2499 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2500 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2501 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002502 }
2503
Dave Houltonee281a52017-12-08 13:51:02 -07002504 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2505 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2506 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002507 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002508 skip |= LogError(dst_state->image, vuid,
2509 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2510 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2511 "height (%d).",
2512 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002513 }
2514
Dave Houltonee281a52017-12-08 13:51:02 -07002515 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2516 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2517 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002518 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002519 skip |= LogError(
2520 dst_state->image, vuid,
2521 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2522 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2523 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002524 }
2525 } // Compressed
2526 }
2527 return skip;
2528}
2529
Dave Houltonc991cc92018-03-06 11:08:51 -07002530// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002531bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002532 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002533 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002534
2535 // Neither image is multiplane
2536 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2537 // If neither image is multi-plane the aspectMask member of src and dst must match
2538 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2539 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002540 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002541 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002542 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002543 }
2544 } else {
2545 // Source image multiplane checks
2546 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2547 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2548 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2549 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002550 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002551 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002552 }
2553 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2554 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2555 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002556 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002557 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002558 }
2559 // Single-plane to multi-plane
2560 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2561 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2562 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002563 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002564 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002565 }
2566
2567 // Dest image multiplane checks
2568 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2569 aspect = region.dstSubresource.aspectMask;
2570 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2571 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002572 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002573 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002574 }
2575 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2576 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2577 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002578 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002579 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002580 }
2581 // Multi-plane to single-plane
2582 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2583 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2584 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002585 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002586 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002587 }
2588 }
2589
2590 return skip;
2591}
2592
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002593bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2594 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002595 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002596 const auto *cb_node = GetCBState(commandBuffer);
2597 const auto *src_image_state = GetImageState(srcImage);
2598 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002599 const VkFormat src_format = src_image_state->createInfo.format;
2600 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002601 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002602
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002603 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002604
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002605 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2606
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002607 for (uint32_t i = 0; i < regionCount; i++) {
2608 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002609
2610 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2611 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002612 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002613
Dave Houlton6f9059e2017-05-02 17:15:13 -06002614 bool slice_override = false;
2615 uint32_t depth_slices = 0;
2616
2617 // Special case for copying between a 1D/2D array and a 3D image
2618 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2619 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2620 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002621 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002622 slice_override = (depth_slices != 1);
2623 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2624 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002625 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002626 slice_override = (depth_slices != 1);
2627 }
2628
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002629 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2630 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2631 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002632 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002633 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002634 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002635 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002636 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2637 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002638 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002639 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2640 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002641
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002642 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002643 // No chance of mismatch if we're overriding depth slice count
2644 if (!slice_override) {
2645 // The number of depth slices in srcSubresource and dstSubresource must match
2646 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2647 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002648 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2649 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002650 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002651 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2652 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002653 if (src_slices != dst_slices) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002654 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140",
2655 "vkCmdCopyImage(): number of depth slices in source and destination subresources for "
2656 "pRegions[%u] do not match.",
2657 i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002658 }
2659 }
2660 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002661 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002662 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002663 skip |= LogError(
2664 command_buffer, "VUID-VkImageCopy-layerCount-00138",
2665 "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[%u] do not match", i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002666 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002667 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002668
Dave Houltonc991cc92018-03-06 11:08:51 -07002669 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002670 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002671 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002672 }
2673
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002674 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002675 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2676 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002677 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002678 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002679 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002680 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002681
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002682 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002683 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002684 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002685 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002686 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002687 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002688 }
2689
2690 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002691 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002692 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002693 ss << "vkCmdCopyImage(): pRegion[" << i
2694 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002695 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002696 }
2697
Dave Houltonfc1a4052017-04-27 14:32:45 -06002698 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002699 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2700 if (slice_override) src_copy_extent.depth = depth_slices;
2701 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002702 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002703 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002704 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2705 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2706 "width [%1d].",
2707 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002708 }
2709
2710 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002711 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002712 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2713 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2714 "height [%1d].",
2715 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002716 }
2717 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002718 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002719 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2720 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2721 "depth [%1d].",
2722 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002723 }
2724
Dave Houltonee281a52017-12-08 13:51:02 -07002725 // Adjust dest extent if necessary
2726 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2727 if (slice_override) dst_copy_extent.depth = depth_slices;
2728
2729 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002730 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002731 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2732 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2733 "width [%1d].",
2734 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002735 }
2736 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002737 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2738 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2739 "height [%1d].",
2740 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002741 }
2742 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002743 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2744 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2745 "depth [%1d].",
2746 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002747 }
2748
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002749 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2750 // must not overlap in memory
2751 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002752 for (uint32_t j = 0; j < regionCount; j++) {
2753 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002754 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002755 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002756 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002757 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002758 }
2759 }
2760 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002761
2762 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2763 if (device_extensions.vk_khr_maintenance1) {
2764 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2765 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2766 (src_copy_extent.depth != 1)) {
2767 skip |= LogError(
2768 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2769 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2770 src_copy_extent.depth);
2771 }
2772 } else {
2773 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2774 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2775 (src_copy_extent.depth != 1)) {
2776 skip |= LogError(
2777 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2778 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2779 src_copy_extent.depth);
2780 }
2781 }
2782
2783 // Check if 2D with 3D and depth not equal to 2D layerCount
2784 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2785 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2786 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2787 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2788 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2789 "srcSubresource.layerCount (%u)",
2790 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2791 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2792 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2793 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2794 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2795 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2796 "dstSubresource.layerCount (%u)",
2797 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2798 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002799
2800 // Check for multi-plane format compatiblity
2801 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
2802 size_t src_format_size = 0;
2803 size_t dst_format_size = 0;
2804 if (FormatIsMultiplane(src_format)) {
2805 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
2806 src_format_size = FormatElementSize(planeFormat);
2807 } else {
2808 src_format_size = FormatElementSize(src_format);
2809 }
2810 if (FormatIsMultiplane(dst_format)) {
2811 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
2812 dst_format_size = FormatElementSize(planeFormat);
2813 } else {
2814 dst_format_size = FormatElementSize(dst_format);
2815 }
2816 // If size is still zero, then format is invalid and will be caught in another VU
2817 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
2818 skip |=
2819 LogError(command_buffer, "VUID-vkCmdCopyImage-None-01549",
2820 "vkCmdCopyImage(): pRegions[%u] called with non-compatible image formats. "
2821 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
2822 i, string_VkFormat(src_format), string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(),
2823 string_VkFormat(dst_format), string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
2824 }
2825 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002826 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002827
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002828 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
2829 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
2830 // because because both texels are 4 bytes in size.
2831 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
2832 const char *compatible_vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2833 : "VUID-vkCmdCopyImage-srcImage-00135";
2834 // Depth/stencil formats must match exactly.
2835 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2836 if (src_format != dst_format) {
2837 skip |= LogError(command_buffer, compatible_vuid,
2838 "vkCmdCopyImage(): Depth/stencil formats must match exactly for src (%s) and dst (%s).",
2839 string_VkFormat(src_format), string_VkFormat(dst_format));
2840 }
2841 } else {
2842 if (!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) {
2843 skip |= LogError(command_buffer, compatible_vuid,
2844 "vkCmdCopyImage(): Unmatched image format sizes. "
2845 "The src format %s has size of %zu and dst format %s has size of %zu.",
2846 string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
2847 FormatElementSize(dst_format));
2848 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002849 }
2850 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002851
Dave Houlton33c22b72017-02-28 13:16:02 -07002852 // Source and dest image sample counts must match
2853 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2854 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002855 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002856 }
2857
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002858 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2859 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002860 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002861 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2862 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2863 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2864 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02002865
2866 // Validation for VK_EXT_fragment_density_map
2867 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2868 skip |= LogError(
2869 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2870 "vkCmdCopyImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2871 }
2872 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2873 skip |= LogError(
2874 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2875 "vkCmdCopyImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2876 }
2877
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002878 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002879 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002880 "VUID-vkCmdCopyImage-srcImage-01995");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002881 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002882 "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002883 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002884 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002885 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002886 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2887 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002888 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002889 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2890 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2891 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2892 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2893 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2894 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002895 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002896 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002897 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2898 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002899 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002900 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2901 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002902 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2903 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002904 }
2905
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002906 return skip;
2907}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002908
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002909void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2910 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2911 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002912 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2913 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002914 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002915 auto src_image_state = GetImageState(srcImage);
2916 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002917
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002918 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002919 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002920 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2921 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002922 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002923}
2924
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002925// Returns true if sub_rect is entirely contained within rect
2926static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2927 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2928 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2929 return false;
2930 return true;
2931}
2932
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002933bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002934 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2935 const VkRect2D &render_area, uint32_t rect_count,
2936 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002937 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002938 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2939 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06002940 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07002941 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002942
2943 for (uint32_t j = 0; j < rect_count; j++) {
2944 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002945 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2946 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2947 "the current render pass instance.",
2948 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002949 }
2950
2951 if (image_view_state) {
2952 // The layers specified by a given element of pRects must be contained within every attachment that
2953 // pAttachments refers to
2954 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2955 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2956 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002957 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2958 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2959 "of pAttachment[%d].",
2960 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002961 }
2962 }
2963 }
2964 return skip;
2965}
2966
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002967bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2968 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002969 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002970 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002971 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002972 if (!cb_node) return skip;
2973
2974 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2975 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2976 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002977 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002978
2979 // Validate that attachment is in reference list of active subpass
2980 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002981 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002982 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002983 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06002984 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07002985 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002986
John Zulauf3a548ef2019-02-01 16:14:07 -07002987 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2988 auto clear_desc = &pAttachments[attachment_index];
2989 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002990
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002991 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002992 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002993 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002994 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002995 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002996 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2997 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2998 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2999 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003000 skip |= LogError(
3001 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3002 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3003 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3004 attachment_index, clear_desc->colorAttachment,
3005 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3006 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003007
John Zulauff2582972019-02-09 14:53:30 -07003008 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3009 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003010 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003011 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3012 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3013 " subpass %u. colorAttachmentCount=%u",
3014 attachment_index, clear_desc->colorAttachment,
3015 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3016 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003017 }
John Zulauff2582972019-02-09 14:53:30 -07003018 fb_attachment = color_attachment;
3019
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003020 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3021 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3022 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003023 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003024 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003025 }
3026 } else { // Must be depth and/or stencil
3027 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
3028 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003029 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003030 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003031 }
3032 if (!subpass_desc->pDepthStencilAttachment ||
3033 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003034 skip |= LogPerformanceWarning(
3035 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003036 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003037 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003038 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003039 }
3040 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003041 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003042 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3043 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003044 }
3045 }
3046 }
3047 return skip;
3048}
3049
3050void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3051 const VkClearAttachment *pAttachments, uint32_t rectCount,
3052 const VkClearRect *pRects) {
3053 auto *cb_node = GetCBState(commandBuffer);
3054 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3055 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3056 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3057 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3058 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3059 const auto clear_desc = &pAttachments[attachment_index];
3060 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3061 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3062 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3063 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3064 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3065 subpass_desc->pDepthStencilAttachment) {
3066 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3067 }
3068 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003069 if (!clear_rect_copy) {
3070 // We need a copy of the clear rectangles that will persist until the last lambda executes
3071 // but we want to create it as lazily as possible
3072 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003073 }
John Zulauf441558b2019-08-12 11:47:39 -06003074 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3075 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003076 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003077 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003078 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003079 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3080 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003081 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
3082 clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003083 return skip;
3084 };
3085 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003086 }
3087 }
3088 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003089}
3090
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003091bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3092 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003093 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003094 const auto *cb_node = GetCBState(commandBuffer);
3095 const auto *src_image_state = GetImageState(srcImage);
3096 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003097
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003098 bool skip = false;
3099 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003100 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3101 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003102 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003103 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003104 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3105 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003106 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003107 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003108
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003109 // Validation for VK_EXT_fragment_density_map
3110 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3111 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3112 "vkCmdResolveImage(): srcImage must not have been created with flags containing "
3113 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3114 }
3115 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3116 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3117 "vkCmdResolveImage(): dstImage must not have been created with flags containing "
3118 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3119 }
3120
Cort Stratton7df30962018-05-17 19:45:57 -07003121 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003122 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003123 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003124 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3125 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3126 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003127 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003128 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3129 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003130 // For each region, the number of layers in the image subresource should not be zero
3131 // For each region, src and dest image aspect must be color only
3132 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003133 const VkImageSubresourceLayers src_subresource = pRegions[i].srcSubresource;
3134 const VkImageSubresourceLayers dst_subresource = pRegions[i].dstSubresource;
3135 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, "vkCmdResolveImage()", "srcSubresource", i);
3136 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, "vkCmdResolveImage()", "dstSubresource", i);
3137 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003138 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3139 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003140 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003141 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3142 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003143 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003144 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003145 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003146 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003147 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
3148 src_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003149 "VUID-vkCmdResolveImage-srcSubresource-01711");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003150 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
3151 dst_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003152 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003153
3154 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003155 if (src_subresource.layerCount != dst_subresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003156 skip |= LogError(
3157 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003158 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%u] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003159 }
Cort Stratton7df30962018-05-17 19:45:57 -07003160 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003161 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3162 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3163 skip |= LogError(
3164 cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266",
3165 "vkCmdResolveImage(): src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3166 i);
3167 }
3168
3169 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3170 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3171
3172 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
3173 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount) ||
3174 (0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3175 LogObjectList objlist(cb_node->commandBuffer);
3176 objlist.add(src_image_state->image);
3177 objlist.add(dst_image_state->image);
3178 skip |= LogError(objlist, "VUID-VkImageResolve-srcImage-00268",
3179 "vkCmdResolveImage(): pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
3180 "subresources if the src or dst image is 3D.",
3181 i);
3182 }
3183 }
3184
3185 if (VK_IMAGE_TYPE_1D == src_image_type) {
3186 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3187 LogObjectList objlist(cb_node->commandBuffer);
3188 objlist.add(src_image_state->image);
3189 skip |= LogError(objlist, "VUID-VkImageResolve-srcImage-00271",
3190 "vkCmdResolveImage(): srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
3191 "extent.height (%u) is not 1.",
3192 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.y,
3193 pRegions[i].extent.height);
3194 }
3195 }
3196 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3197 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3198 LogObjectList objlist(cb_node->commandBuffer);
3199 objlist.add(src_image_state->image);
3200 skip |= LogError(objlist, "VUID-VkImageResolve-srcImage-00273",
3201 "vkCmdResolveImage(): srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
3202 "extent.depth (%u) is not 1.",
3203 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.z,
3204 pRegions[i].extent.depth);
3205 }
3206 }
3207
3208 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3209 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3210 LogObjectList objlist(cb_node->commandBuffer);
3211 objlist.add(dst_image_state->image);
3212 skip |= LogError(objlist, "VUID-VkImageResolve-dstImage-00276",
3213 "vkCmdResolveImage(): dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
3214 "extent.height (%u) is not 1.",
3215 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.y,
3216 pRegions[i].extent.height);
3217 }
3218 }
3219 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3220 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3221 LogObjectList objlist(cb_node->commandBuffer);
3222 objlist.add(dst_image_state->image);
3223 skip |= LogError(objlist, "VUID-VkImageResolve-dstImage-00278",
3224 "vkCmdResolveImage(): dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
3225 "extent.depth (%u) is not 1.",
3226 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.z,
3227 pRegions[i].extent.depth);
3228 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003229 }
3230 }
3231
3232 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003233 skip |=
3234 LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-01386",
3235 "vkCmdResolveImage(): srcImage format (%s) and dstImage format (%s) are not the same.",
3236 string_VkFormat(src_image_state->createInfo.format), string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003237 }
3238 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003239 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
3240 "vkCmdResolveImage(): srcImage type (%s) and dstImage type (%s) are not the same.",
3241 string_VkImageType(src_image_state->createInfo.imageType),
3242 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003243 }
3244 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003245 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257",
3246 "vkCmdResolveImage(): srcImage sample count is VK_SAMPLE_COUNT_1_BIT.");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003247 }
3248 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003249 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259",
3250 "vkCmdResolveImage(): dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3251 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003252 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003253 } else {
3254 assert(0);
3255 }
3256 return skip;
3257}
3258
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003259bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3260 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003261 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003262 const auto *cb_node = GetCBState(commandBuffer);
3263 const auto *src_image_state = GetImageState(srcImage);
3264 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003265
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003266 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003267 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003268 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003269 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003270 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003271 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003272 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003273 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003274 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003275 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3276 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003277 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003278 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3279 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003280 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003281 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3282 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003283 skip |=
3284 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003285 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3286 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003287 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003288 "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003289 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003290 "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003291
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003292 // Validation for VK_EXT_fragment_density_map
3293 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3294 skip |= LogError(
3295 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3296 "vkCmdBlitImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3297 }
3298 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3299 skip |= LogError(
3300 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3301 "vkCmdBlitImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3302 }
3303
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003304 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003305
Dave Houlton33c2d252017-06-09 17:08:32 -06003306 VkFormat src_format = src_image_state->createInfo.format;
3307 VkFormat dst_format = dst_image_state->createInfo.format;
3308 VkImageType src_type = src_image_state->createInfo.imageType;
3309 VkImageType dst_type = dst_image_state->createInfo.imageType;
3310
Cort Stratton186b1a22018-05-01 20:18:06 -04003311 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003312 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003313 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003314 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003315 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003316 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003317 }
3318
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003319 if (FormatRequiresYcbcrConversion(src_format)) {
3320 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3321 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3322 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3323 string_VkFormat(src_format));
3324 }
3325
3326 if (FormatRequiresYcbcrConversion(dst_format)) {
3327 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3328 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3329 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3330 string_VkFormat(dst_format));
3331 }
3332
Dave Houlton33c2d252017-06-09 17:08:32 -06003333 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003334 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3335 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003336 }
3337
Dave Houlton33c2d252017-06-09 17:08:32 -06003338 // Validate consistency for unsigned formats
3339 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3340 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003341 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003342 << "the other one must also have unsigned integer format. "
3343 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003344 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003345 }
3346
3347 // Validate consistency for signed formats
3348 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3349 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003350 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003351 << "the other one must also have signed integer format. "
3352 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003353 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003354 }
3355
3356 // Validate filter for Depth/Stencil formats
3357 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3358 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003359 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003360 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003361 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003362 }
3363
3364 // Validate aspect bits and formats for depth/stencil images
3365 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3366 if (src_format != dst_format) {
3367 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003368 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003369 << "stencil, the other one must have exactly the same format. "
3370 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3371 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003372 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003373 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003374 } // Depth or Stencil
3375
3376 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003377 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003378 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003379 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3380 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3381 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003382 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003383 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3384 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003385 for (uint32_t i = 0; i < regionCount; i++) {
3386 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003387 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003388 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003389 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3390 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003391 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003392 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3393 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003394 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3395 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3396 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003397 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003398 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003399 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003400 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003401 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3402 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003403 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003404 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3405 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003406 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003407 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3408 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003409 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003410 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003411 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003412 }
Dave Houlton48989f32017-05-26 15:01:46 -06003413 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3414 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003415 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003416 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003417 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003418 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003419
3420 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003421 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003422 skip |= LogError(
3423 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003424 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003425 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003426
Dave Houlton48989f32017-05-26 15:01:46 -06003427 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003428 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3429 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003430 }
Dave Houlton48989f32017-05-26 15:01:46 -06003431
Dave Houlton33c2d252017-06-09 17:08:32 -06003432 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003433 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3434 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3435 "image format %s.",
3436 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003437 }
3438
3439 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003440 skip |= LogError(
3441 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003442 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3443 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003444 }
3445
Dave Houlton48989f32017-05-26 15:01:46 -06003446 // Validate source image offsets
3447 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003448 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003449 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003450 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003451 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3452 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3453 "of (%1d, %1d). These must be (0, 1).",
3454 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003455 }
3456 }
3457
Dave Houlton33c2d252017-06-09 17:08:32 -06003458 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003459 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003460 skip |=
3461 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3462 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3463 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3464 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003465 }
3466 }
3467
Dave Houlton33c2d252017-06-09 17:08:32 -06003468 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003469 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3470 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003471 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003472 skip |= LogError(
3473 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003474 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3475 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003476 }
3477 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3478 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003479 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003480 skip |= LogError(
3481 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003482 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003483 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003484 }
3485 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3486 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003487 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003488 skip |= LogError(
3489 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003490 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3491 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003492 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003493 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003494 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3495 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003496 }
Dave Houlton48989f32017-05-26 15:01:46 -06003497
3498 // Validate dest image offsets
3499 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003500 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003501 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003502 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003503 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3504 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3505 "(%1d, %1d). These must be (0, 1).",
3506 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003507 }
3508 }
3509
Dave Houlton33c2d252017-06-09 17:08:32 -06003510 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003511 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003512 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3513 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3514 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3515 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003516 }
3517 }
3518
Dave Houlton33c2d252017-06-09 17:08:32 -06003519 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003520 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3521 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003522 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003523 skip |= LogError(
3524 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003525 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3526 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003527 }
3528 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3529 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003530 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003531 skip |= LogError(
3532 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003533 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003534 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003535 }
3536 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3537 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003538 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003539 skip |= LogError(
3540 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003541 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3542 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003543 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003544 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003545 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3546 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003547 }
3548
Dave Houlton33c2d252017-06-09 17:08:32 -06003549 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3550 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3551 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003552 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003553 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3554 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3555 "layerCount other than 1.",
3556 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003557 }
3558 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003559 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003560 } else {
3561 assert(0);
3562 }
3563 return skip;
3564}
3565
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003566void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3567 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3568 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003569 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3570 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003571 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003572 auto src_image_state = GetImageState(srcImage);
3573 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003574
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003575 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003576 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003577 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3578 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003579 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003580}
3581
John Zulauf2076e812020-01-08 14:55:54 -07003582GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3583 assert(map);
3584 // This approach allows for a single hash lookup or/create new
3585 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3586 if (inserted.second) {
3587 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06003588 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07003589 inserted.first->second.reset(layout_map);
3590 return layout_map;
3591 } else {
3592 assert(nullptr != inserted.first->second.get());
3593 return inserted.first->second.get();
3594 }
3595 return nullptr;
3596}
3597
3598const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3599 auto it = map.find(image);
3600 if (it != map.end()) {
3601 return it->second.get();
3602 }
3603 return nullptr;
3604}
3605
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003606// 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 -07003607bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3608 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06003609 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003610 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003611 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003612 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003613 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003614 for (const auto &layout_map_entry : pCB->image_layout_map) {
3615 const auto image = layout_map_entry.first;
3616 const auto *image_state = GetImageState(image);
3617 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003618 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003619 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003620 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003621 if (initial_layout_map.empty()) continue;
3622
3623 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3624 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3625 if (global_map == nullptr) {
3626 global_map = &empty_map;
3627 }
3628
3629 // Note: don't know if it would matter
3630 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3631
3632 auto pos = initial_layout_map.begin();
3633 const auto end = initial_layout_map.end();
3634 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3635 pos->first.begin);
3636 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003637 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003638 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003639 if (current_layout->range.empty()) break; // When we are past the end of data in overlay and global... stop looking
locke-lunargf155ccf2020-02-18 11:34:15 -07003640 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003641 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003642 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003643 image_layout = current_layout->pos_B->lower_bound->second;
3644 }
3645 const auto intersected_range = pos->first & current_layout->range;
3646 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3647 // TODO: Set memory invalid which is in mem_tracker currently
3648 } else if (image_layout != initial_layout) {
3649 // Need to look up the inital layout *state* to get a bit more information
3650 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3651 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3652 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3653 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07003654 // We can report all the errors for the intersected range directly
3655 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06003656 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003657 skip |= LogError(
3658 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003659 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003660 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07003661 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003662 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06003663 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003664 }
3665 }
John Zulauf2076e812020-01-08 14:55:54 -07003666 if (pos->first.includes(intersected_range.end)) {
3667 current_layout.seek(intersected_range.end);
3668 } else {
3669 ++pos;
3670 if (pos != end) {
3671 current_layout.seek(pos->first.begin);
3672 }
3673 }
John Zulauff660ad62019-03-23 07:16:05 -06003674 }
3675
locke-lunargf155ccf2020-02-18 11:34:15 -07003676 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003677 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003678 }
John Zulauff660ad62019-03-23 07:16:05 -06003679
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003680 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003681}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003682
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003683void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003684 for (const auto &layout_map_entry : pCB->image_layout_map) {
3685 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003686 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003687 const auto *image_state = GetImageState(image);
3688 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003689 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3690 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003691 }
3692}
3693
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003694// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003695// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3696// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003697bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3698 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003699 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003700 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003701 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3702
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003703 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07003704 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
3705 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003706 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003707 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3708 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3709 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003710 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003711 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003712 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07003713 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3714 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
3715 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003716 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003717 string_VkImageLayout(first_layout));
3718 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3719 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003720 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003721 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003722 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003723 }
3724 }
sfricke-samsung55f01952020-03-24 08:16:41 -07003725
3726 // Same as above for loadOp, but for stencilLoadOp
3727 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3728 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3729 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3730 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
3731 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003732 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003733 string_VkImageLayout(first_layout));
3734 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3735 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
3736 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003737 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003738 string_VkImageLayout(first_layout));
3739 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3740 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3741 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003742 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003743 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003744 }
3745 }
3746
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003747 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003748}
3749
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003750bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3751 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003752 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003753 const char *vuid;
3754 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003755
Jason Ekstranda1906302017-12-03 20:16:32 -08003756 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3757 VkFormat format = pCreateInfo->pAttachments[i].format;
3758 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3759 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3760 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003761 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003762 "%s: Render pass pAttachment[%u] has loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003763 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3764 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
sfricke-samsung6595d272020-05-13 22:43:06 -07003765 "render pass.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003766 function_name, i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003767 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003768 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003769 skip |=
3770 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3771 "%s: Render pass pAttachment[%u] has stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3772 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3773 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3774 "render pass.",
3775 function_name, i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003776 }
3777 }
3778 }
3779
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003780 // Track when we're observing the first use of an attachment
3781 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3782 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003783 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003784
3785 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3786 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3787 auto attach_index = subpass.pInputAttachments[j].attachment;
3788 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003789 switch (subpass.pInputAttachments[j].layout) {
3790 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3791 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3792 // These are ideal.
3793 break;
3794
3795 case VK_IMAGE_LAYOUT_GENERAL:
3796 // May not be optimal. TODO: reconsider this warning based on other constraints.
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003797 skip |= LogPerformanceWarning(
3798 device, kVUID_Core_DrawState_InvalidImageLayout,
3799 "%s: Layout for input attachment reference %u in subpass %u is GENERAL but should be READ_ONLY_OPTIMAL.",
3800 function_name, j, i);
Cort Stratton7547f772017-05-04 15:18:52 -07003801 break;
3802
Tobias Hectorbbb12282018-10-22 15:17:59 +01003803 case VK_IMAGE_LAYOUT_UNDEFINED:
3804 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003805 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003806 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003807 "%s: Layout for input attachment reference %u in subpass %u is %s but must be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003808 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003809 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003810 break;
3811
Piers Daniell9af77cd2019-10-16 13:54:12 -06003812 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3813 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3814 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3815 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003816 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003817 skip |= LogError(
3818 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003819 "%s: Layout for input attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06003820 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3821 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003822 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06003823 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003824 skip |= LogError(
3825 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003826 "%s: Layout for input attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06003827 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3828 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003829 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06003830 } else if ((subpass.pInputAttachments[j].aspectMask &
3831 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3832 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3833 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3834 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3835 const auto *attachment_reference_stencil_layout =
3836 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3837 if (attachment_reference_stencil_layout) {
3838 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3839 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3840 attachment_reference_stencil_layout->stencilLayout ==
3841 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3842 attachment_reference_stencil_layout->stencilLayout ==
3843 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3844 attachment_reference_stencil_layout->stencilLayout ==
3845 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3846 attachment_reference_stencil_layout->stencilLayout ==
3847 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3848 attachment_reference_stencil_layout->stencilLayout ==
3849 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3850 attachment_reference_stencil_layout->stencilLayout ==
3851 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3852 attachment_reference_stencil_layout->stencilLayout ==
3853 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3854 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003855 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003856 "%s: In the attachment reference %u in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003857 "VkAttachmentReferenceStencilLayoutKHR"
3858 "the stencilLayout member but must not be "
3859 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3860 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3861 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3862 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3863 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3864 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3865 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3866 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3867 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003868 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003869 }
3870 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003871 skip |= LogError(
3872 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003873 "%s: When the layout for input attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003874 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3875 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3876 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003877 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003878 }
3879 }
3880 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3881 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3882 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003883 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03315",
3884 "%s: When the aspectMask for input attachment reference %u in subpass %u is "
3885 "VK_IMAGE_ASPECT_DEPTH_BIT "
3886 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3887 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3888 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003889 }
3890 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3891 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3892 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003893 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003894 "%s: When the aspectMask for input attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003895 "VK_IMAGE_ASPECT_STENCIL_BIT "
3896 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3897 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003898 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003899 }
3900 }
3901 break;
3902
Graeme Leese668a9862018-10-08 10:40:02 +01003903 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3904 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003905 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003906 break;
3907 } else {
3908 // Intentionally fall through to generic error message
3909 }
3910 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003911
Cort Stratton7547f772017-05-04 15:18:52 -07003912 default:
3913 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003914 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003915 "%s: Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3916 function_name, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003917 }
3918
Cort Stratton7547f772017-05-04 15:18:52 -07003919 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003920 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3921 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003922
3923 bool used_as_depth =
3924 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3925 bool used_as_color = false;
3926 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3927 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3928 }
3929 if (!used_as_depth && !used_as_color &&
3930 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003931 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003932 skip |= LogError(device, vuid,
3933 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
Mark Lobodzinski6ff146b2020-05-22 14:37:05 -06003934 function_name, attach_index, i);
Cort Stratton7547f772017-05-04 15:18:52 -07003935 }
3936 }
3937 attach_first_use[attach_index] = false;
3938 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003939
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003940 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3941 auto attach_index = subpass.pColorAttachments[j].attachment;
3942 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3943
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003944 // TODO: Need a way to validate shared presentable images here, currently just allowing
3945 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3946 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003947 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003948 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003949 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003950 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3951 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003952 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003953
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003954 case VK_IMAGE_LAYOUT_GENERAL:
3955 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003956 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003957 "%s: Layout for color attachment reference %u in subpass %u is GENERAL but "
3958 "should be COLOR_ATTACHMENT_OPTIMAL.",
3959 function_name, j, i);
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003960 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003961
Tobias Hectorbbb12282018-10-22 15:17:59 +01003962 case VK_IMAGE_LAYOUT_UNDEFINED:
3963 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003964 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003965 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003966 "%s: Layout for color attachment reference %u in subpass %u is %s but should be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003967 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003968 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003969 break;
3970
Piers Daniell9af77cd2019-10-16 13:54:12 -06003971 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3972 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3973 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3974 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003975 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003976 skip |= LogError(
3977 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003978 "%s: Layout for color attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06003979 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3980 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003981 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06003982 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003983 skip |= LogError(
3984 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003985 "%s: Layout for color attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06003986 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3987 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003988 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06003989 } else if ((subpass.pColorAttachments[j].aspectMask &
3990 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3991 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3992 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3993 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3994 const auto *attachment_reference_stencil_layout =
3995 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3996 if (attachment_reference_stencil_layout) {
3997 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3998 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3999 attachment_reference_stencil_layout->stencilLayout ==
4000 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4001 attachment_reference_stencil_layout->stencilLayout ==
4002 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4003 attachment_reference_stencil_layout->stencilLayout ==
4004 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4005 attachment_reference_stencil_layout->stencilLayout ==
4006 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4007 attachment_reference_stencil_layout->stencilLayout ==
4008 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4009 attachment_reference_stencil_layout->stencilLayout ==
4010 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4011 attachment_reference_stencil_layout->stencilLayout ==
4012 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4013 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004014 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004015 "%s: In the attachment reference %u in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004016 "VkAttachmentReferenceStencilLayoutKHR"
4017 "the stencilLayout member but must not be "
4018 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4019 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4020 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4021 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4022 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4023 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4024 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4025 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4026 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004027 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004028 }
4029 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004030 skip |= LogError(
4031 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004032 "%s: When the layout for color attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004033 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4034 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4035 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004036 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004037 }
4038 }
4039 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4040 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4041 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004042 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03315",
4043 "%s: When the aspectMask for color attachment reference %u in subpass %u is "
4044 "VK_IMAGE_ASPECT_DEPTH_BIT "
4045 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4046 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4047 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004048 }
4049 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4050 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4051 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004052 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004053 "%s: When the aspectMask for color attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004054 "VK_IMAGE_ASPECT_STENCIL_BIT "
4055 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4056 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004057 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004058 }
4059 }
4060 break;
4061
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004062 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004063 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004064 "%s: Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
4065 function_name, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004066 }
4067
John Zulauf4eee2692019-02-09 16:14:25 -07004068 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
4069 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
4070 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08004071 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004072 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004073 "%s: Layout for resolve attachment reference %u in subpass %u is %s but should be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004074 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004075 function_name, j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004076 }
4077
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004078 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004079 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
4080 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004081 }
4082 attach_first_use[attach_index] = false;
4083 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004084
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004085 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
4086 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004087 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
4088 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
4089 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06004090 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06004091
Dave Houltona9df0ce2018-02-07 10:51:23 -07004092 case VK_IMAGE_LAYOUT_GENERAL:
4093 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
4094 // doing a bunch of transitions.
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004095 skip |= LogPerformanceWarning(
4096 device, kVUID_Core_DrawState_InvalidImageLayout,
4097 "%s: GENERAL layout for depth attachment reference in subpass %u may not give optimal performance.",
4098 function_name, i);
Dave Houltona9df0ce2018-02-07 10:51:23 -07004099 break;
4100
Tobias Hectorbbb12282018-10-22 15:17:59 +01004101 case VK_IMAGE_LAYOUT_UNDEFINED:
4102 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004103 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004104 skip |=
4105 LogError(device, vuid,
4106 "%s: Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
4107 "layout or GENERAL.",
4108 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004109 break;
4110
Piers Daniell9af77cd2019-10-16 13:54:12 -06004111 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4112 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4113 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4114 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004115 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004116 skip |= LogError(
4117 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004118 "%s: Layout for depth attachment reference in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004119 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4120 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004121 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004122 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004123 skip |= LogError(
4124 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004125 "%s: Layout for depth attachment reference in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004126 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4127 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004128 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004129 } else if ((subpass.pDepthStencilAttachment->aspectMask &
4130 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4131 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4132 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4133 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4134 const auto *attachment_reference_stencil_layout =
4135 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
4136 if (attachment_reference_stencil_layout) {
4137 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4138 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4139 attachment_reference_stencil_layout->stencilLayout ==
4140 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4141 attachment_reference_stencil_layout->stencilLayout ==
4142 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4143 attachment_reference_stencil_layout->stencilLayout ==
4144 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4145 attachment_reference_stencil_layout->stencilLayout ==
4146 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4147 attachment_reference_stencil_layout->stencilLayout ==
4148 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4149 attachment_reference_stencil_layout->stencilLayout ==
4150 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4151 attachment_reference_stencil_layout->stencilLayout ==
4152 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4153 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004154 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004155 "%s: In the attachment reference in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004156 "VkAttachmentReferenceStencilLayoutKHR"
4157 "the stencilLayout member but must not be "
4158 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4159 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4160 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4161 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4162 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4163 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4164 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4165 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4166 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004167 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004168 }
4169 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004170 skip |= LogError(
4171 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004172 "%s: When the layout for depth attachment reference in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004173 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4174 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4175 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004176 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004177 }
4178 }
4179 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4180 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4181 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004182 skip |= LogError(
4183 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004184 "%s: When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004185 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4186 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004187 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004188 }
4189 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4190 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4191 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004192 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004193 "%s: When the aspectMask for depth attachment reference in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004194 "VK_IMAGE_ASPECT_STENCIL_BIT "
4195 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4196 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004197 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004198 }
4199 }
4200 break;
4201
Dave Houltona9df0ce2018-02-07 10:51:23 -07004202 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4203 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004204 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004205 break;
4206 } else {
4207 // Intentionally fall through to generic error message
4208 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004209 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004210
Dave Houltona9df0ce2018-02-07 10:51:23 -07004211 default:
4212 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004213 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004214 "%s: Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004215 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004216 function_name, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004217 }
4218
4219 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4220 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004221 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4222 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004223 }
4224 attach_first_use[attach_index] = false;
4225 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004226 }
4227 return skip;
4228}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004229
Mark Lobodzinski96210742017-02-09 10:33:46 -07004230// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4231// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004232template <typename T1>
4233bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4234 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4235 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004236 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004237 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004238 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004239 if (strict) {
4240 correct_usage = ((actual & desired) == desired);
4241 } else {
4242 correct_usage = ((actual & desired) != 0);
4243 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004244
Mark Lobodzinski96210742017-02-09 10:33:46 -07004245 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004246 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004247 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004248 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
4249 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4250 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004251 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004252 skip = LogError(object, msgCode,
4253 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4254 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004255 }
4256 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004257 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004258}
4259
4260// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4261// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004262bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004263 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004264 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004265 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004266}
4267
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004268bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004269 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004270 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004271 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4272 if ((image_format_features & desired) != desired) {
4273 // Same error, but more details if it was an AHB external format
4274 if (image_state->has_ahb_format == true) {
4275 skip |= LogError(image_state->image, vuid,
4276 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4277 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4278 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004279 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004280 } else {
4281 skip |= LogError(image_state->image, vuid,
4282 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4283 "with tiling %s.",
4284 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4285 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4286 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004287 }
4288 }
4289 return skip;
4290}
4291
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004292bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004293 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004294 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004295 // layerCount must not be zero
4296 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004297 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4298 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004299 }
4300 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4301 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004302 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4303 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004304 }
4305 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4306 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4307 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004308 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4309 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4310 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4311 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004312 }
4313 return skip;
4314}
4315
Mark Lobodzinski96210742017-02-09 10:33:46 -07004316// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4317// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004318bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004319 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004320 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004321 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004322}
4323
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004324bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004325 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004326 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004327
4328 const VkDeviceSize &range = pCreateInfo->range;
4329 if (range != VK_WHOLE_SIZE) {
4330 // Range must be greater than 0
4331 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004332 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004333 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004334 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4335 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004336 }
4337 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004338 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4339 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004340 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004341 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004342 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4343 "(%" PRIu32 ").",
4344 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004345 }
4346 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004347 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004348 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004349 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004350 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4351 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4352 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004353 }
4354 // The sum of range and offset must be less than or equal to the size of buffer
4355 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004356 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004357 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004358 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4359 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4360 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004361 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004362 } else {
4363 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4364
4365 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4366 // VkPhysicalDeviceLimits::maxTexelBufferElements
4367 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4368 device_limits->maxTexelBufferElements) {
4369 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4370 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4371 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4372 "), divided by the element size of the format (%" PRIu32
4373 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4374 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4375 device_limits->maxTexelBufferElements);
4376 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004377 }
4378 return skip;
4379}
4380
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004381bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004382 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004383 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004384 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4385 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004386 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004387 "vkCreateBufferView(): If buffer was created with `usage` containing "
4388 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004389 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004390 }
4391 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4392 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004393 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004394 "vkCreateBufferView(): If buffer was created with `usage` containing "
4395 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004396 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004397 }
4398 return skip;
4399}
4400
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004401bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004402 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004403 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004404
Dave Houltond8ed0212018-05-16 17:18:24 -06004405 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004406
Jeff Bolz87697532019-01-11 22:54:00 -06004407 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4408 if (chained_devaddr_struct) {
4409 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4410 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004411 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4412 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4413 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004414 }
4415 }
4416
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004417 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4418 if (chained_opaqueaddr_struct) {
4419 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4420 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004421 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4422 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4423 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004424 }
4425 }
4426
Shannon McPherson4984e642019-12-05 13:04:34 -07004427 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004428 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4429 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004430 skip |= LogError(
4431 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004432 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4433 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4434 }
4435
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004436 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004437 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4438 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4439 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004440 }
4441
sfricke-samsungedce77a2020-07-03 22:35:13 -07004442 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4443 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4444 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4445 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4446 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4447 }
4448 const VkBufferCreateFlags invalid_flags =
4449 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4450 if ((pCreateInfo->flags & invalid_flags) != 0) {
4451 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4452 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4453 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4454 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4455 }
4456 }
4457
Mark Lobodzinski96210742017-02-09 10:33:46 -07004458 return skip;
4459}
4460
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004461bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004462 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004463 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004464 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004465 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4466 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004467 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004468 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4469 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004470 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004471 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4472 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4473 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004474
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004475 // Buffer view offset must be less than the size of buffer
4476 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004477 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004478 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004479 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4480 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004481 }
4482
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004483 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004484 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4485 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4486 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004487 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4488 : "VUID-VkBufferViewCreateInfo-offset-00926";
4489 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004490 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004491 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4492 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004493 }
4494
4495 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4496 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4497 if ((elementSize % 3) == 0) {
4498 elementSize /= 3;
4499 }
4500 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4501 VkDeviceSize alignmentRequirement =
4502 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4503 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4504 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4505 }
4506 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004507 skip |= LogError(
4508 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004509 "vkCreateBufferView(): If buffer was created with usage containing "
4510 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004511 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4512 ") must be a multiple of the lesser of "
4513 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4514 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4515 "(%" PRId32
4516 ") is VK_TRUE, the size of a texel of the requested format. "
4517 "If the size of a texel is a multiple of three bytes, then the size of a "
4518 "single component of format is used instead",
4519 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4520 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4521 }
4522 }
4523 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4524 VkDeviceSize alignmentRequirement =
4525 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4526 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4527 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4528 }
4529 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004530 skip |= LogError(
4531 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004532 "vkCreateBufferView(): If buffer was created with usage containing "
4533 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004534 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4535 ") must be a multiple of the lesser of "
4536 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4537 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4538 "(%" PRId32
4539 ") is VK_TRUE, the size of a texel of the requested format. "
4540 "If the size of a texel is a multiple of three bytes, then the size of a "
4541 "single component of format is used instead",
4542 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4543 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4544 }
4545 }
4546 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004547
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004548 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004549
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004550 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004551 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004552 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004553}
4554
Mark Lobodzinski602de982017-02-09 11:01:33 -07004555// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004556bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004557 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004558 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004559 const IMAGE_STATE *image_state = GetImageState(image);
4560 // checks color format and (single-plane or non-disjoint)
4561 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004562 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004563 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004564 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 -07004565 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004566 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 -07004567 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004568 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004569 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004570 skip |= LogError(image, vuid,
4571 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4572 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4573 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004574 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004575 skip |= LogError(image, vuid,
4576 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4577 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4578 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004579 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004580 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004581 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004582 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 -07004583 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004584 skip |=
4585 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 -07004586 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004587 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004588 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004589 skip |=
4590 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 -07004591 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004592 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4593 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004594 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004595 } else if (FormatIsMultiplane(format)) {
4596 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4597 if (3 == FormatPlaneCount(format)) {
4598 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4599 }
4600 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004601 skip |=
4602 LogError(image, vuid,
4603 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4604 "set, where n = [0, 1, 2].",
4605 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004606 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004607 }
4608 return skip;
4609}
4610
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004611bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4612 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004613 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4614 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004615 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004616
4617 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004618 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004619 skip |= LogError(image, errorCodes.base_mip_err,
4620 "%s: %s.baseMipLevel (= %" PRIu32
4621 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4622 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004623 }
Petr Kraus4d718682017-05-18 03:38:41 +02004624
Petr Krausffa94af2017-08-08 21:46:02 +02004625 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4626 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004627 skip |=
4628 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004629 } else {
4630 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004631
Petr Krausffa94af2017-08-08 21:46:02 +02004632 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004633 skip |= LogError(image, errorCodes.mip_count_err,
4634 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4635 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4636 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4637 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004638 }
Petr Kraus4d718682017-05-18 03:38:41 +02004639 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004640 }
Petr Kraus4d718682017-05-18 03:38:41 +02004641
4642 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004643 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004644 skip |= LogError(image, errorCodes.base_layer_err,
4645 "%s: %s.baseArrayLayer (= %" PRIu32
4646 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4647 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004648 }
Petr Kraus4d718682017-05-18 03:38:41 +02004649
Petr Krausffa94af2017-08-08 21:46:02 +02004650 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4651 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004652 skip |=
4653 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004654 } else {
4655 const uint64_t necessary_layer_count =
4656 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004657
Petr Krausffa94af2017-08-08 21:46:02 +02004658 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004659 skip |= LogError(image, errorCodes.layer_count_err,
4660 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4661 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4662 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4663 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004664 }
Petr Kraus4d718682017-05-18 03:38:41 +02004665 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004666 }
Petr Kraus4d718682017-05-18 03:38:41 +02004667
Mark Lobodzinski602de982017-02-09 11:01:33 -07004668 return skip;
4669}
4670
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004671bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004672 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004673 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004674 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4675 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4676 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4677
4678 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4679 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4680
4681 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004682 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4683 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004684 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004685 : "VUID-VkImageViewCreateInfo-image-01482")
4686 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4687 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004688 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004689 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4690 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004691
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004692 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004693 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004694 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004695}
4696
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004697bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004698 const VkImageSubresourceRange &subresourceRange,
4699 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004700 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004701 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4702 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4703 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4704 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004705
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004706 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004707 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004708 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004709}
4710
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004711bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004712 const VkImageSubresourceRange &subresourceRange,
4713 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004714 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004715 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4716 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4717 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4718 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004719
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004720 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004721 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4722 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004723}
4724
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004725bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004726 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004727 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004728 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004729 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4730 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4731 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4732 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004733
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004734 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004735 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004736}
4737
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004738bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4739 const VkImageUsageFlags image_usage) const {
4740 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4741 bool skip = false;
4742
4743 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4744 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4745
4746 if (image_state->has_ahb_format == true) {
4747 // AHB image view and image share same feature sets
4748 tiling_features = image_state->format_features;
4749 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4750 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4751 assert(device_extensions.vk_ext_image_drm_format_modifier);
4752 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4753 nullptr};
4754 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4755
4756 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4757 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4758 nullptr};
4759 format_properties_2.pNext = (void *)&drm_properties_list;
4760 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4761
4762 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4763 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4764 0) {
4765 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4766 }
4767 }
4768 } else {
4769 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4770 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4771 : format_properties.optimalTilingFeatures;
4772 }
4773
4774 if (tiling_features == 0) {
4775 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4776 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4777 "physical device.",
4778 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4779 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4780 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4781 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4782 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4783 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4784 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4785 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4786 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4787 "VK_IMAGE_USAGE_STORAGE_BIT.",
4788 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4789 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4790 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4791 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4792 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4793 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4794 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4795 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4796 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4797 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4798 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4799 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4800 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4801 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4802 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4803 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4804 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4805 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4806 }
4807
4808 return skip;
4809}
4810
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004811bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004812 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004813 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004814 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004815 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004816 skip |=
4817 ValidateImageUsageFlags(image_state,
4818 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4819 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4820 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4821 false, kVUIDUndefined, "vkCreateImageView()",
4822 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4823 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004824 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004825 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004826 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004827 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004828 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004829 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004830
4831 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4832 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004833 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004834 VkFormat view_format = pCreateInfo->format;
4835 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004836 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004837 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004838
Dave Houltonbd2e2622018-04-10 16:41:14 -06004839 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004840 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004841 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004842 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004843 if (!device_extensions.vk_ext_separate_stencil_usage) {
4844 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004845 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4846 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4847 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004848 }
4849 } else {
4850 const auto image_stencil_struct =
4851 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4852 if (image_stencil_struct == nullptr) {
4853 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004854 skip |= LogError(
4855 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004856 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4857 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4858 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4859 }
4860 } else {
4861 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4862 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4863 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004864 skip |= LogError(
4865 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004866 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4867 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4868 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4869 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4870 }
4871 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4872 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004873 skip |= LogError(
4874 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004875 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4876 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4877 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4878 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4879 }
4880 }
4881 }
4882 }
4883
Dave Houltonbd2e2622018-04-10 16:41:14 -06004884 image_usage = chained_ivuci_struct->usage;
4885 }
4886
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004887 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4888 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004889 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004890 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004891 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004892 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004893 std::stringstream ss;
4894 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004895 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004896 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004897 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004898 }
4899 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004900 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06004901 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4902 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004903 const char *error_vuid;
4904 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4905 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4906 } else if ((device_extensions.vk_khr_maintenance2) &&
4907 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4908 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4909 } else if ((!device_extensions.vk_khr_maintenance2) &&
4910 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4911 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4912 } else {
4913 // both enabled
4914 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4915 }
Dave Houltonc7988072018-04-16 11:46:56 -06004916 std::stringstream ss;
4917 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004918 << " is not in the same format compatibility class as "
4919 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004920 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4921 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004922 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004923 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004924 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004925 }
4926 } else {
4927 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004928 // Unless it is a multi-planar color bit aspect
4929 if ((image_format != view_format) &&
4930 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4931 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4932 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004933 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004934 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004935 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004936 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004937 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004938 }
4939 }
4940
4941 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004942 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004943
4944 switch (image_type) {
4945 case VK_IMAGE_TYPE_1D:
4946 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004947 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4948 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4949 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004950 }
4951 break;
4952 case VK_IMAGE_TYPE_2D:
4953 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4954 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4955 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004956 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4957 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4958 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004959 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004960 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4961 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4962 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004963 }
4964 }
4965 break;
4966 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004967 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004968 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4969 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4970 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004971 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004972 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4973 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4974 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004975 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4976 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004977 skip |= LogError(
4978 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4979 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4980 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4981 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4982 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004983 }
4984 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004985 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4986 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4987 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004988 }
4989 }
4990 } else {
4991 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004992 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4993 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4994 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004995 }
4996 }
4997 break;
4998 default:
4999 break;
5000 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005001
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005002 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005003 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005004 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005005 }
5006
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005007 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005008
Jeff Bolz9af91c52018-09-01 21:53:57 -05005009 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5010 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005011 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5012 "vkCreateImageView() If image was created with usage containing "
5013 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
5014 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005015 }
5016 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005017 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5018 "vkCreateImageView() If image was created with usage containing "
5019 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005020 }
5021 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005022
5023 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5024 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5025 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5026 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5027 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5028 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5029 }
5030 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5031 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5032 skip |= LogError(
5033 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5034 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5035 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5036 }
5037 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005038
5039 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5040 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005041 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005042 "vkCreateImageView(): If image was created with usage containing "
5043 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5044 pCreateInfo->subresourceRange.levelCount);
5045 }
5046 }
5047 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5048 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005049 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005050 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5051 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5052 }
5053 } else {
5054 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5055 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5056 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005057 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005058 "vkCreateImageView(): If image was created with usage containing "
5059 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5060 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5061 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5062 }
5063 }
5064 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005065
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005066 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5067 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5068 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5069 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5070 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5071 }
5072 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5073 skip |=
5074 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5075 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5076 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5077 }
5078 }
5079 if (device_extensions.vk_ext_fragment_density_map_2) {
5080 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5081 (pCreateInfo->subresourceRange.layerCount >
5082 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5083 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5084 "vkCreateImageView(): If image was created with flags containing "
5085 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5086 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5087 pCreateInfo->subresourceRange.layerCount,
5088 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5089 }
5090 }
5091
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005092 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
5093 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5094 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5095 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5096 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5097 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5098 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5099 }
5100 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005101 }
5102 return skip;
5103}
5104
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005105bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
5106 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005107 bool skip = false;
5108
5109 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5110 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5111 VkDeviceSize src_min = UINT64_MAX;
5112 VkDeviceSize src_max = 0;
5113 VkDeviceSize dst_min = UINT64_MAX;
5114 VkDeviceSize dst_max = 0;
5115
5116 for (uint32_t i = 0; i < regionCount; i++) {
5117 src_min = std::min(src_min, pRegions[i].srcOffset);
5118 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5119 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5120 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5121
5122 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5123 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005124 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
5125 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
5126 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5127 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005128 }
5129
5130 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5131 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005132 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
5133 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
5134 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5135 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005136 }
5137
5138 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5139 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005140 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
5141 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5142 ") is greater than the source buffer size (%" PRIuLEAST64
5143 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
5144 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005145 }
5146
5147 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5148 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005149 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
5150 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5151 ") is greater than the destination buffer size (%" PRIuLEAST64
5152 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
5153 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005154 }
5155 }
5156
5157 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5158 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5159 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005160 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
5161 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005162 }
5163 }
5164
5165 return skip;
5166}
5167
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005168bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005169 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005170 const auto cb_node = GetCBState(commandBuffer);
5171 const auto src_buffer_state = GetBufferState(srcBuffer);
5172 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005173
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005174 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005175 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5176 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005177 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005178 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005179 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5180 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005181 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005182 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5183 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005184 skip |=
5185 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5186 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005187 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5188 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005189 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005190 return skip;
5191}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005192
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005193bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005194 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005195 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005196 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005197 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
5198 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005199 } else {
5200 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005201 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5202 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005203 }
5204 }
5205 return skip;
5206}
5207
Jeff Bolz5c801d12019-10-09 10:38:45 -05005208bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5209 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005210 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005211 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005212
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005213 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005214 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005215 skip |=
5216 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005217 }
5218 return skip;
5219}
5220
Jeff Bolz5c801d12019-10-09 10:38:45 -05005221bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005222 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005223
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005224 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005225 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005226 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005227 }
5228 return skip;
5229}
5230
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005231bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005232 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005233 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005234 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005235 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005236 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005237 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005238 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005239 }
5240 return skip;
5241}
5242
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005243bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005244 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005245 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005246 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005247 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005248 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005249 skip |=
5250 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5251 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005252 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005253 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005254 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5255 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005256 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005257
5258 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005259 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5260 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5261 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5262 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005263 }
5264
5265 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005266 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5267 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5268 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5269 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005270 }
5271
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005272 return skip;
5273}
5274
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005275bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
5276 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005277 bool skip = false;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005278 assert(image_state != nullptr);
5279 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005280
5281 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005282 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005283 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5284 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005285 skip |=
5286 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
5287 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5288 "and 1, respectively.",
5289 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005290 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005291 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005292
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005293 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5294 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005295 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
5296 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
5297 "must be 0 and 1, respectively.",
5298 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005299 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005300 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005301
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005302 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5303 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005304 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
5305 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5306 "For 3D images these must be 0 and 1, respectively.",
5307 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005308 }
5309 }
5310
5311 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005312 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005313 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005314
sfricke-samsung125d2b42020-05-28 06:32:43 -07005315 // If not depth/stencil and not multi-plane
5316 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5317 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
5318 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-bufferOffset-01558"
5319 : "VUID-VkBufferImageCopy-bufferOffset-00193";
5320 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005321 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5322 " must be a multiple of this format's texel size (%" PRIu32 ").",
5323 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005324 }
5325
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005326 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5327 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005328 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005329 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
5330 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5331 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005332 }
5333
5334 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5335 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005336 skip |= LogError(
5337 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005338 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5339 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005340 }
5341
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005342 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005343 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005344 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005345 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adjusted_image_extent.width)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06005346 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5347 static_cast<int32_t>(adjusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005348 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
5349 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5350 "zero or <= image subresource width (%d).",
5351 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005352 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005353 }
5354
5355 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005356 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adjusted_image_extent.height)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06005357 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5358 static_cast<int32_t>(adjusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005359 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
5360 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5361 "zero or <= image subresource height (%d).",
5362 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005363 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005364 }
5365
5366 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005367 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adjusted_image_extent.depth)) ||
Mark Lobodzinski72b1a222020-03-18 11:36:10 -06005368 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5369 static_cast<int32_t>(adjusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005370 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
5371 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5372 "zero or <= image subresource depth (%d).",
5373 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005374 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005375 }
5376
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005377 // subresource aspectMask must have exactly 1 bit set
5378 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005379 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005380 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005381 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005382 "%s(): aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005383 }
5384
5385 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005386 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005387 skip |= LogError(
5388 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005389 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
sfricke-samsung125d2b42020-05-28 06:32:43 -07005390 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005391 }
5392
5393 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005394 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5395 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005396
5397 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005398 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005399 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5400 ? "VUID-VkBufferImageCopy-None-01735"
5401 : "VUID-VkBufferImageCopy-bufferRowLength-00203";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005402 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005403 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005404 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5405 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005406 }
5407
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005408 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005409 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005410 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5411 ? "VUID-VkBufferImageCopy-None-01736"
5412 : "VUID-VkBufferImageCopy-bufferImageHeight-00204";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005413 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005414 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005415 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5416 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005417 }
5418
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005419 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005420 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5421 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5422 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005423 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01737"
5424 : "VUID-VkBufferImageCopy-imageOffset-00205";
5425 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005426 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5427 "width & height (%d, %d)..",
5428 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5429 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005430 }
5431
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005432 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005433 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005434 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005435 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5436 ? "VUID-VkBufferImageCopy-None-01738"
5437 : "VUID-VkBufferImageCopy-bufferOffset-00206";
5438 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005439 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5440 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5441 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005442 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005443
5444 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005445 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005446 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005447 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005448 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01739"
5449 : "VUID-VkBufferImageCopy-imageExtent-00207";
5450 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005451 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5452 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5453 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5454 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005455 }
5456
5457 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005458 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005459 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005460 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01740"
5461 : "VUID-VkBufferImageCopy-imageExtent-00208";
5462 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005463 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5464 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5465 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5466 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005467 }
5468
5469 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005470 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005471 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005472 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01741"
5473 : "VUID-VkBufferImageCopy-imageExtent-00209";
5474 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005475 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5476 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5477 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5478 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005479 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005480 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005481
5482 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005483 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005484 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005485 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005486 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5487 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5488 "format has three planes.",
5489 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005490 }
5491
5492 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005493 if (0 ==
5494 (region_aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005495 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5496 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5497 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5498 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005499 } else {
5500 // Know aspect mask is valid
5501 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5502 const uint32_t compatible_size = FormatElementSize(compatible_format);
5503 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5504 skip |= LogError(
5505 image_state->image, "VUID-VkBufferImageCopy-bufferOffset-01559",
5506 "%s(): pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
5507 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5508 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5509 string_VkFormat(compatible_format));
5510 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005511 }
5512 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005513 }
5514
5515 return skip;
5516}
5517
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005518bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5519 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005520 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005521 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005522
5523 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005524 VkExtent3D extent = pRegions[i].imageExtent;
5525 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005526
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005527 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5528 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005529 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5530 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5531 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005532 }
5533
5534 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5535
5536 // 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 -06005537 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005538 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005539 if (image_extent.width % block_extent.width) {
5540 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5541 }
5542 if (image_extent.height % block_extent.height) {
5543 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5544 }
5545 if (image_extent.depth % block_extent.depth) {
5546 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5547 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005548 }
5549
Dave Houltonfc1a4052017-04-27 14:32:45 -06005550 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005551 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005552 }
5553 }
5554
5555 return skip;
5556}
5557
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005558bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5559 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005560 bool skip = false;
5561
5562 VkDeviceSize buffer_size = buff_state->createInfo.size;
5563
5564 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005565 VkDeviceSize max_buffer_offset =
5566 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5567 if (buffer_size < max_buffer_offset) {
5568 skip |=
5569 LogError(device, msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005570 }
5571 }
5572
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005573 return skip;
5574}
5575
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005576bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005577 VkBuffer dstBuffer, uint32_t regionCount,
5578 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005579 const auto cb_node = GetCBState(commandBuffer);
5580 const auto src_image_state = GetImageState(srcImage);
5581 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005582
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005583 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005584
5585 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005586 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005587
5588 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005589 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005590
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005591 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005592
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005593 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005594 skip |=
5595 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5596 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5597 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005598 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005599 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005600 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005601 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005602 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005603
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005604 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005605 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005606 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5607 skip |=
5608 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005609
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005610 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005611 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005612 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5613 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005614 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005615 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5616 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005617
5618 // Validation for VK_EXT_fragment_density_map
5619 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5620 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyImageToBuffer-srcImage-02544",
5621 "vkCmdCopyBufferToImage(): srcImage must not have been created with flags containing "
5622 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5623 }
5624
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005625 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005626 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005627 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005628 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005629 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005630 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005631 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5632 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5633 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005634 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005635 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005636 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005637 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005638 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5639 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005640 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5641 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5642 skip |=
5643 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5644 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5645 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005646 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5647 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005648 }
5649 return skip;
5650}
5651
John Zulauf1686f232019-07-09 16:27:11 -06005652void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5653 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5654 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5655
5656 auto cb_node = GetCBState(commandBuffer);
5657 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005658 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005659 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005660 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005661 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005662}
5663
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005664bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5665 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005666 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005667 const auto cb_node = GetCBState(commandBuffer);
5668 const auto src_buffer_state = GetBufferState(srcBuffer);
5669 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005670
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005671 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005672
5673 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005674 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005675
5676 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005677 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005678 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005679 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005680 skip |=
5681 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5682 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5683 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005684 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005685 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005686 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005687 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005688 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005689 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005690 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005691 skip |=
5692 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5693 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005694 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005695 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5696 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005697 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005698 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5699 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005700
5701 // Validation for VK_EXT_fragment_density_map
5702 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5703 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyBufferToImage-dstImage-02543",
5704 "vkCmdCopyBufferToImage(): dstImage must not have been created with flags containing "
5705 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5706 }
5707
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005708 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005709 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005710 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005711 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005712 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005713 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005714 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5715 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5716 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005717 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005718 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005719 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005720 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005721 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5722 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005723 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5724 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5725 skip |=
5726 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5727 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5728 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005729 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5730 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005731 }
5732 return skip;
5733}
5734
John Zulauf1686f232019-07-09 16:27:11 -06005735void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5736 VkImageLayout dstImageLayout, uint32_t regionCount,
5737 const VkBufferImageCopy *pRegions) {
5738 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5739
5740 auto cb_node = GetCBState(commandBuffer);
5741 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005742 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005743 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005744 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005745 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005746}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005747
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005748bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005749 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005750 bool skip = false;
5751 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5752
Dave Houlton1d960ff2018-01-19 12:17:05 -07005753 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005754 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5755 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5756 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005757 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5758 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005759 }
5760
John Zulaufa26d3c82019-08-14 16:09:08 -06005761 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005762 if (!image_entry) {
5763 return skip;
5764 }
5765
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005766 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5767 if (device_extensions.vk_ext_image_drm_format_modifier) {
5768 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5769 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005770 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5771 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5772 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005773 }
5774 } else {
5775 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005776 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5777 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005778 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005779 }
5780
Dave Houlton1d960ff2018-01-19 12:17:05 -07005781 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005782 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005783 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5784 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5785 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005786 }
5787
Dave Houlton1d960ff2018-01-19 12:17:05 -07005788 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005789 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005790 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5791 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5792 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005793 }
5794
Dave Houlton1d960ff2018-01-19 12:17:05 -07005795 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005796 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005797 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5798 if (FormatIsMultiplane(img_format)) {
5799 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5800 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5801 if (FormatPlaneCount(img_format) > 2u) {
5802 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5803 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5804 }
5805 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005806 skip |= LogError(image, vuid,
5807 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5808 ") must be a single-plane specifier flag.",
5809 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005810 }
5811 } else if (FormatIsColor(img_format)) {
5812 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005813 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5814 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5815 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005816 }
5817 } else if (FormatIsDepthOrStencil(img_format)) {
5818 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5819 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005820 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005821 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5822 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5823 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5824 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005825 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5826 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5827 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005828 }
5829 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005830
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005831 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005832 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005833 }
5834
Mike Weiblen672b58b2017-02-21 14:32:53 -07005835 return skip;
5836}