blob: 30a2114efdb6e73e69696a5662dd51aa8e0de1aa [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
John Zulauff660ad62019-03-23 07:16:05 -060064IMAGE_STATE::IMAGE_STATE(VkImage img, const VkImageCreateInfo *pCreateInfo)
65 : 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),
unknown08c57af2019-06-21 16:33:35 -060087 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060088 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
89 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
90 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
91 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
92 }
93 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
94 }
95
96 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
97 sparse = true;
98 }
Locked8af3732019-05-10 09:47:56 -060099
sfricke-samsunge2441192019-11-06 14:07:57 -0800100 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
101 if (externalMemoryInfo) {
102 external_memory_handle = externalMemoryInfo->handleTypes;
103 }
John Zulauff660ad62019-03-23 07:16:05 -0600104}
105
unknown2c877272019-07-11 12:56:50 -0600106bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
107 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
108 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
109 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
110 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
111 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
112 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600113 return is_equal &&
114 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600115}
116
Jeff Bolz82f854d2019-09-17 14:56:47 -0500117// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
118bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
119 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
120 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
121 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
122 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
123 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600124 is_compatible = is_compatible &&
125 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
126 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500127
128 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
129 createInfo.extent.height <= other_createInfo.extent.height &&
130 createInfo.extent.depth <= other_createInfo.extent.depth &&
131 createInfo.arrayLayers <= other_createInfo.arrayLayers;
132 return is_compatible;
133}
134
unknown2c877272019-07-11 12:56:50 -0600135bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700136 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
137 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
138 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700139 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
140 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600141 IsCreateInfoEqual(other_image_state->createInfo)) {
142 return true;
143 }
unknowne1661522019-07-11 13:04:18 -0600144 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
145 return true;
146 }
unknown2c877272019-07-11 12:56:50 -0600147 return false;
148}
149
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500150IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
151 : image_view(iv),
152 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700153 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
154 range_generator(im->range_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500155 samplerConversion(VK_NULL_HANDLE),
156 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600157 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
158 if (conversionInfo) samplerConversion = conversionInfo->conversion;
159 if (image_state) {
160 // A light normalization of the createInfo range
161 auto &sub_res_range = create_info.subresourceRange;
162 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
163 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
164
165 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700166 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500167 samples = image_state->createInfo.samples;
168 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600169 }
170}
171
Dave Houltond9611312018-11-19 17:03:36 -0700172uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
173 // uint cast applies floor()
174 return 1u + (uint32_t)log2(std::max({height, width, depth}));
175}
176
177uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
178
179uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
180
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500181bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700182 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700183 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700184
John Zulauf2076e812020-01-08 14:55:54 -0700185 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
186 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700187 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
188 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
189
John Zulauf2076e812020-01-08 14:55:54 -0700190 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
191
192 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
193 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700194 return false;
195 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700196
John Zulauf2076e812020-01-08 14:55:54 -0700197 for (auto entry : *layout_range_map) {
198 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700199 }
200 return true;
201}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700202
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600203// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600204void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600205 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
206 VkImageLayout expected_layout) {
207 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
208 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600209 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600210 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700211 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700212 for (const auto &image : image_state.aliasing_images) {
213 auto alias_state = GetImageState(image);
214 // The map state of the aliases should all be in sync, so no need to check the return value
215 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
216 assert(subresource_map);
217 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
218 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700219}
John Zulauff660ad62019-03-23 07:16:05 -0600220
221// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600222void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600223 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500224 return;
225 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500226 IMAGE_STATE *image_state = view_state.image_state.get();
227 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700228 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700229 for (const auto &image : image_state->aliasing_images) {
230 image_state = GetImageState(image);
231 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
232 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
233 }
John Zulauff660ad62019-03-23 07:16:05 -0600234}
235
236// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600237void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600238 const VkImageSubresourceRange &range, VkImageLayout layout) {
239 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
240 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600241 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700242 for (const auto &image : image_state.aliasing_images) {
243 auto alias_state = GetImageState(image);
244 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
245 assert(subresource_map);
246 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
247 }
John Zulauff660ad62019-03-23 07:16:05 -0600248}
249
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600250void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600251 VkImageLayout layout) {
252 const IMAGE_STATE *image_state = GetImageState(image);
253 if (!image_state) return;
254 SetImageInitialLayout(cb_node, *image_state, range, layout);
255};
256
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600257void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600258 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
259 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600260}
Dave Houltonddd65c52018-05-08 14:58:01 -0600261
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600262// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700263void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
264 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500265 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600266
John Zulauff660ad62019-03-23 07:16:05 -0600267 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600268 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
269 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600270 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 -0600271 sub_range.baseArrayLayer = 0;
272 sub_range.layerCount = image_state->createInfo.extent.depth;
273 }
274
Piers Daniell4fde9b72019-11-27 16:19:46 -0700275 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
276 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
277 SetImageLayout(cb_node, *image_state, sub_range, layout);
278 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
279 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
280 } else {
281 SetImageLayout(cb_node, *image_state, sub_range, layout);
282 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600283}
284
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700285bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
286 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700287 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600288 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100289 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700290 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100291 const char *vuid;
292 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700293 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100294
295 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600296 LogObjectList objlist(image);
297 objlist.add(renderpass);
298 objlist.add(framebuffer);
299 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700300 skip |=
301 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
302 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
303 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
304 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100305 return skip;
306 }
307
308 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200309 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
310 if (stencil_usage_info) {
311 image_usage |= stencil_usage_info->stencilUsage;
312 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100313
314 // Check for layouts that mismatch image usages in the framebuffer
315 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800316 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600317 LogObjectList objlist(image);
318 objlist.add(renderpass);
319 objlist.add(framebuffer);
320 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700321 skip |= LogError(objlist, vuid,
322 "%s: Layout/usage mismatch for attachment %u in %s"
323 " - the %s is %s but the image attached to %s via %s"
324 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
325 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
326 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
327 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100328 }
329
330 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
331 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800332 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600333 LogObjectList objlist(image);
334 objlist.add(renderpass);
335 objlist.add(framebuffer);
336 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700337 skip |= LogError(objlist, vuid,
338 "%s: Layout/usage mismatch for attachment %u in %s"
339 " - the %s is %s but the image attached to %s via %s"
340 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
341 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
342 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
343 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100344 }
345
346 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800347 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600348 LogObjectList objlist(image);
349 objlist.add(renderpass);
350 objlist.add(framebuffer);
351 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700352 skip |= LogError(objlist, vuid,
353 "%s: Layout/usage mismatch for attachment %u in %s"
354 " - the %s is %s but the image attached to %s via %s"
355 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
356 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
357 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
358 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100359 }
360
361 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800362 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600363 LogObjectList objlist(image);
364 objlist.add(renderpass);
365 objlist.add(framebuffer);
366 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700367 skip |= LogError(objlist, vuid,
368 "%s: Layout/usage mismatch for attachment %u in %s"
369 " - the %s is %s but the image attached to %s via %s"
370 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
371 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
372 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
373 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100374 }
375
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600376 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100377 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
378 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
379 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
380 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
381 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800382 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600383 LogObjectList objlist(image);
384 objlist.add(renderpass);
385 objlist.add(framebuffer);
386 objlist.add(image_view);
387 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700388 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700389 " - the %s is %s but the image attached to %s via %s"
390 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700391 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700392 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
393 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100394 }
395 } else {
396 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
397 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
398 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
399 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600400 LogObjectList objlist(image);
401 objlist.add(renderpass);
402 objlist.add(framebuffer);
403 objlist.add(image_view);
404 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700405 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700406 " - the %s is %s but the image attached to %s via %s"
407 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700408 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700409 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
410 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100411 }
412 }
413 return skip;
414}
415
John Zulauf17a01bb2019-08-09 16:41:19 -0600416bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700417 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600418 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600419 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700420 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700421 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100422 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100423
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700424 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100425 auto framebuffer = framebuffer_state->framebuffer;
426
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700427 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700428 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
429 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700430 }
John Zulauf8e308292018-09-21 11:34:37 -0600431
Tobias Hectorc9057422019-07-23 12:15:52 +0100432 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
433 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
434 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100435 }
436
Tobias Hectorc9057422019-07-23 12:15:52 +0100437 if (attachments != nullptr) {
438 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
439 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
440 auto image_view = attachments[i];
441 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100442
Tobias Hectorc9057422019-07-23 12:15:52 +0100443 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600444 LogObjectList objlist(pRenderPassBegin->renderPass);
445 objlist.add(framebuffer_state->framebuffer);
446 objlist.add(image_view);
447 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700448 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
449 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
450 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100451 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100452 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100453
454 const VkImage image = view_state->create_info.image;
455 const IMAGE_STATE *image_state = GetImageState(image);
456
457 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600458 LogObjectList objlist(pRenderPassBegin->renderPass);
459 objlist.add(framebuffer_state->framebuffer);
460 objlist.add(image_view);
461 objlist.add(image);
462 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700463 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
464 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
465 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100466 continue;
467 }
468 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
469 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
470
Piers Daniell7f894f62020-01-09 16:33:48 -0700471 // Default to expecting stencil in the same layout.
472 auto attachment_stencil_initial_layout = attachment_initial_layout;
473
474 // If a separate layout is specified, look for that.
475 const auto *attachment_description_stencil_layout =
476 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
477 if (attachment_description_stencil_layout) {
478 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
479 }
480
Tobias Hectorc9057422019-07-23 12:15:52 +0100481 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
482 // in common with the non-const version.)
483 const ImageSubresourceLayoutMap *subresource_map =
484 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
485
486 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
487 LayoutUseCheckAndMessage layout_check(subresource_map);
488 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700489 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
490 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
491 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700492
John Zulauf5e617452019-11-19 14:44:16 -0700493 // Allow for differing depth and stencil layouts
494 VkImageLayout check_layout = attachment_initial_layout;
495 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
496
497 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700498 subres_skip |= LogError(
499 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700500 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
501 "and the %s layout of the attachment is %s. The layouts must match, or the render "
502 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700503 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100504 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700505 }
John Zulauf5e617452019-11-19 14:44:16 -0700506
Tobias Hectorc9057422019-07-23 12:15:52 +0100507 skip |= subres_skip;
508 }
509
510 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
511 framebuffer, render_pass, i, "initial layout");
512
513 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
514 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100515 }
516
Tobias Hectorc9057422019-07-23 12:15:52 +0100517 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
518 auto &subpass = pRenderPassInfo->pSubpasses[j];
519 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
520 auto &attachment_ref = subpass.pInputAttachments[k];
521 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
522 auto image_view = attachments[attachment_ref.attachment];
523 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100524
Tobias Hectorc9057422019-07-23 12:15:52 +0100525 if (view_state) {
526 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700527 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
528 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100529 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100530 }
531 }
532 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100533
Tobias Hectorc9057422019-07-23 12:15:52 +0100534 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
535 auto &attachment_ref = subpass.pColorAttachments[k];
536 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
537 auto image_view = attachments[attachment_ref.attachment];
538 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100539
Tobias Hectorc9057422019-07-23 12:15:52 +0100540 if (view_state) {
541 auto image = view_state->create_info.image;
542 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
543 framebuffer, render_pass, attachment_ref.attachment,
544 "color attachment layout");
545 if (subpass.pResolveAttachments) {
546 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
547 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
548 attachment_ref.attachment, "resolve attachment layout");
549 }
550 }
551 }
552 }
553
554 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
555 auto &attachment_ref = *subpass.pDepthStencilAttachment;
556 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
557 auto image_view = attachments[attachment_ref.attachment];
558 auto view_state = GetImageViewState(image_view);
559
560 if (view_state) {
561 auto image = view_state->create_info.image;
562 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
563 framebuffer, render_pass, attachment_ref.attachment,
564 "input attachment layout");
565 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100566 }
567 }
568 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700569 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600570 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700571}
572
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600573void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700574 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700575 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700576 IMAGE_VIEW_STATE *image_view = nullptr;
577 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
578 const auto attachment_info =
579 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
580 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
581 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300582 image_view = GetAttachmentImageViewState(pCB, pFramebuffer, ref.attachment);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700583 }
John Zulauf8e308292018-09-21 11:34:37 -0600584 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700585 VkImageLayout stencil_layout = kInvalidLayout;
586 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
587 if (attachment_reference_stencil_layout) {
588 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
589 }
590
591 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600592 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700593 }
594}
595
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600596void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
597 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700598 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700599
600 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700601 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700602 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700603 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700604 }
605 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700606 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700607 }
608 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700609 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700610 }
611 }
612}
613
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700614// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
615// 1. Transition into initialLayout state
616// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600617void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700618 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700619 // First transition into initialLayout
620 auto const rpci = render_pass_state->createInfo.ptr();
621 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700622 IMAGE_VIEW_STATE *view_state = nullptr;
623 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
624 const auto attachment_info =
625 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
626 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
627 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300628 view_state = GetAttachmentImageViewState(cb_state, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700629 }
John Zulauf8e308292018-09-21 11:34:37 -0600630 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700631 VkImageLayout stencil_layout = kInvalidLayout;
632 const auto *attachment_description_stencil_layout =
633 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
634 if (attachment_description_stencil_layout) {
635 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
636 }
637
638 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600639 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700640 }
641 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700642 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700643}
644
Dave Houlton10b39482017-03-16 13:18:15 -0600645bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600646 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600647 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600648 }
649 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600650 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600651 }
652 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600653 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600654 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700655 if (0 !=
656 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
657 if (FormatPlaneCount(format) == 1) return false;
658 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600659 return true;
660}
661
Mike Weiblen62d08a32017-03-07 22:18:27 -0700662// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200663bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
664 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600665 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700666 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200667 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600668 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700669
670 switch (layout) {
671 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
672 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600673 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700674 }
675 break;
676 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
677 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600678 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700679 }
680 break;
681 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
682 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600683 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700684 }
685 break;
686 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
687 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600688 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700689 }
690 break;
691 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
692 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600693 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700694 }
695 break;
696 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
697 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600698 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700699 }
700 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600701 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500702 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
703 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
704 }
705 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700706 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
707 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
708 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
709 }
710 break;
711 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
712 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
713 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
714 }
715 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700716 default:
717 // Other VkImageLayout values do not have VUs defined in this context.
718 break;
719 }
720
Dave Houlton8e9f6542018-05-18 12:18:22 -0600721 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700722 skip |= LogError(img_barrier.image, msg_code,
723 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
724 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
725 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700726 }
727 return skip;
728}
729
730// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600731bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
732 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700733 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700734
Petr Krausad0096a2019-08-09 18:35:04 +0200735 // Scoreboard for checking for duplicate and inconsistent barriers to images
736 struct ImageBarrierScoreboardEntry {
737 uint32_t index;
738 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
739 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
740 const VkImageMemoryBarrier *barrier;
741 };
742 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
743 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
744
John Zulauf463c51e2018-05-31 13:29:20 -0600745 // Scoreboard for duplicate layout transition barriers within the list
746 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
747 ImageBarrierScoreboardImageMap layout_transitions;
748
Mike Weiblen62d08a32017-03-07 22:18:27 -0700749 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200750 const auto &img_barrier = pImageMemoryBarriers[i];
751 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700752
John Zulauf463c51e2018-05-31 13:29:20 -0600753 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
754 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
755 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200756 if (img_barrier.oldLayout != img_barrier.newLayout) {
757 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
758 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600759 if (image_it != layout_transitions.end()) {
760 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200761 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600762 if (subres_it != subres_map.end()) {
763 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200764 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
765 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
766 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700767 skip = LogError(
768 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200769 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600770 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
771 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200772 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
773 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
774 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600775 }
776 entry = new_entry;
777 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200778 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600779 }
780 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200781 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600782 }
783 }
784
Petr Krausad0096a2019-08-09 18:35:04 +0200785 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600786 if (image_state) {
787 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200788 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
789 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600790
791 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
792 if (image_state->layout_locked) {
793 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700794 skip |= LogError(
795 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700796 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600797 " 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 -0700798 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200799 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600800 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600801
John Zulaufa4472282019-08-22 14:44:34 -0600802 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700803 const VkFormat image_format = image_create_info.format;
804 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600805 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700806 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700807 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600808 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
809 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700810 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
811 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
812 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
813 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700814 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600815 }
816 } else {
817 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
818 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -0700819 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
820 ? "VUID-VkImageMemoryBarrier-image-03320"
821 : "VUID-VkImageMemoryBarrier-image-01207";
822 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700823 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
824 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
825 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700826 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600827 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700828 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700829 }
John Zulauff660ad62019-03-23 07:16:05 -0600830
Petr Krausad0096a2019-08-09 18:35:04 +0200831 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
832 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600833 // TODO: Set memory invalid which is in mem_tracker currently
834 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
835 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600836 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600837 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600838 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200839 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700840 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
841 const auto &value = *pos;
842 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700843 subres_skip = LogError(
844 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700845 "%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 -0700846 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700847 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -0700848 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
849 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600850 }
John Zulauf5e617452019-11-19 14:44:16 -0700851 }
John Zulauff660ad62019-03-23 07:16:05 -0600852 skip |= subres_skip;
853 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700854
855 // checks color format and (single-plane or non-disjoint)
856 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
857 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700858 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700859 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
860 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
861 ? "VUID-VkImageMemoryBarrier-image-01671"
862 : "VUID-VkImageMemoryBarrier-image-02902";
863 skip |= LogError(img_barrier.image, vuid,
864 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
865 "but its aspectMask is 0x%" PRIx32 ".",
866 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
867 string_VkFormat(image_format), aspect_mask);
868 }
869 }
870
871 VkImageAspectFlags valid_disjoint_mask =
872 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 -0700873 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700874 ((aspect_mask & valid_disjoint_mask) == 0)) {
875 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
876 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
877 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
878 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
879 string_VkFormat(image_format), aspect_mask);
880 }
881
882 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
883 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
884 "%s: Image barrier %s references %s of format %s has only two planes but included "
885 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
886 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
887 string_VkFormat(image_format), aspect_mask);
888 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700889 }
890 }
891 return skip;
892}
893
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600894bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200895 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700896
Jeff Bolz6835fda2019-10-06 00:15:34 -0500897 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200898 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700899}
900
John Zulauf6b4aae82018-05-09 13:03:36 -0600901template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600902bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
903 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600904 using BarrierRecord = QFOTransferBarrier<Barrier>;
905 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500906 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600907 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
908 const char *barrier_name = BarrierRecord::BarrierName();
909 const char *handle_name = BarrierRecord::HandleName();
910 const char *transfer_type = nullptr;
911 for (uint32_t b = 0; b < barrier_count; b++) {
912 if (!IsTransferOp(&barriers[b])) continue;
913 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700914 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600915 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600916 const auto found = barrier_sets.release.find(barriers[b]);
917 if (found != barrier_sets.release.cend()) {
918 barrier_record = &(*found);
919 transfer_type = "releasing";
920 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600921 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600922 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600923 const auto found = barrier_sets.acquire.find(barriers[b]);
924 if (found != barrier_sets.acquire.cend()) {
925 barrier_record = &(*found);
926 transfer_type = "acquiring";
927 }
928 }
929 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700930 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
931 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
932 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
933 func_name, barrier_name, b, transfer_type, handle_name,
934 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
935 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600936 }
937 }
938 return skip;
939}
940
John Zulaufa4472282019-08-22 14:44:34 -0600941VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
942 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
943}
944
945const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
946 return device_state.GetImageState(barrier.image);
947}
948
949VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
950 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
951}
952
953const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
954 return device_state.GetBufferState(barrier.buffer);
955}
956
957VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
958
John Zulauf6b4aae82018-05-09 13:03:36 -0600959template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600960void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
961 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500962 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600963 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
964 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600965 auto &barrier = barriers[b];
966 if (IsTransferOp(&barrier)) {
967 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600968 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -0600969 barrier_sets.release.emplace(barrier);
970 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -0600971 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -0600972 barrier_sets.acquire.emplace(barrier);
973 }
974 }
975
976 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
977 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
978 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
979 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
980 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
981 auto handle_state = BarrierHandleState(*this, barrier);
982 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
983 if (!mode_concurrent) {
984 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -0500985 cb_state->queue_submit_functions.emplace_back(
986 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
987 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
988 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
989 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -0600990 });
991 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600992 }
993 }
994}
995
John Zulaufa4472282019-08-22 14:44:34 -0600996bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600997 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700998 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -0600999 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001000 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001001 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1002 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001003 return skip;
1004}
1005
John Zulaufa4472282019-08-22 14:44:34 -06001006void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1007 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1008 const VkImageMemoryBarrier *pImageMemBarriers) {
1009 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1010 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001011}
1012
1013template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001014bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001015 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001016 // Record to the scoreboard or report that we have a duplication
1017 bool skip = false;
1018 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1019 if (!inserted.second && inserted.first->second != cb_state) {
1020 // 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 -06001021 LogObjectList objlist(cb_state->commandBuffer);
1022 objlist.add(barrier.handle);
1023 objlist.add(inserted.first->second->commandBuffer);
1024 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001025 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1026 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1027 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1028 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1029 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001030 }
1031 return skip;
1032}
1033
1034template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001035bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1036 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001037 using BarrierRecord = QFOTransferBarrier<Barrier>;
1038 using TypeTag = typename BarrierRecord::Tag;
1039 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001040 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001041 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001042 const char *barrier_name = BarrierRecord::BarrierName();
1043 const char *handle_name = BarrierRecord::HandleName();
1044 // No release should have an extant duplicate (WARNING)
1045 for (const auto &release : cb_barriers.release) {
1046 // Check the global pending release barriers
1047 const auto set_it = global_release_barriers.find(release.handle);
1048 if (set_it != global_release_barriers.cend()) {
1049 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1050 const auto found = set_for_handle.find(release);
1051 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001052 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1053 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1054 " to dstQueueFamilyIndex %" PRIu32
1055 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1056 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1057 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001058 }
1059 }
1060 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1061 }
1062 // Each acquire must have a matching release (ERROR)
1063 for (const auto &acquire : cb_barriers.acquire) {
1064 const auto set_it = global_release_barriers.find(acquire.handle);
1065 bool matching_release_found = false;
1066 if (set_it != global_release_barriers.cend()) {
1067 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1068 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1069 }
1070 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001071 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1072 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1073 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1074 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1075 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001076 }
1077 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1078 }
1079 return skip;
1080}
1081
John Zulauf3b04ebd2019-07-18 14:08:11 -06001082bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001083 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001084 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001085 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001086 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1087 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001088 return skip;
1089}
1090
1091template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001092void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001093 using BarrierRecord = QFOTransferBarrier<Barrier>;
1094 using TypeTag = typename BarrierRecord::Tag;
1095 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001096 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001097
1098 // Add release barriers from this submit to the global map
1099 for (const auto &release : cb_barriers.release) {
1100 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1101 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1102 global_release_barriers[release.handle].insert(release);
1103 }
1104
1105 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1106 for (const auto &acquire : cb_barriers.acquire) {
1107 // NOTE: We're not using [] because we don't want to create entries for missing releases
1108 auto set_it = global_release_barriers.find(acquire.handle);
1109 if (set_it != global_release_barriers.end()) {
1110 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1111 set_for_handle.erase(acquire);
1112 if (set_for_handle.size() == 0) { // Clean up empty sets
1113 global_release_barriers.erase(set_it);
1114 }
1115 }
1116 }
1117}
1118
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001119void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001120 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1121 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001122}
1123
John Zulauf6b4aae82018-05-09 13:03:36 -06001124// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001125void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001126
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001127void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001128 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001129 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001130 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001131
Chris Forbes4de4b132017-08-21 11:27:08 -07001132 // For ownership transfers, the barrier is specified twice; as a release
1133 // operation on the yielding queue family, and as an acquire operation
1134 // on the acquiring queue family. This barrier may also include a layout
1135 // transition, which occurs 'between' the two operations. For validation
1136 // purposes it doesn't seem important which side performs the layout
1137 // transition, but it must not be performed twice. We'll arbitrarily
1138 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001139 //
1140 // However, we still need to record initial layout for the "initial layout" validation
1141 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001142
Petr Krausad0096a2019-08-09 18:35:04 +02001143 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001144 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001145 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001146 }
1147}
1148
unknown86bcb3a2019-07-11 13:05:36 -06001149void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001150 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001151 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1152 const auto &image_create_info = image_state->createInfo;
1153
1154 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1155 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1156 // for all (potential) layer sub_resources.
1157 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1158 normalized_isr.baseArrayLayer = 0;
1159 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1160 }
1161
Michael Spang8af7c102020-05-03 20:50:09 -04001162 VkImageLayout initial_layout = mem_barrier.oldLayout;
1163
1164 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001165 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001166 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1167 }
1168
John Zulauf2be3fe02019-12-30 09:48:02 -07001169 if (is_release_op) {
1170 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1171 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001172 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001173 }
unknown86bcb3a2019-07-11 13:05:36 -06001174}
1175
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001176bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1177 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1178 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1179 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001180 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001181 assert(cb_node);
1182 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001183 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001184 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001185
John Zulauff660ad62019-03-23 07:16:05 -06001186 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1187 if (subresource_map) {
1188 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001189 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001190 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1191 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001192 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001193 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1194 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1195 "%s layout %s.",
1196 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1197 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1198 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001199 }
John Zulauf5e617452019-11-19 14:44:16 -07001200 }
John Zulauff660ad62019-03-23 07:16:05 -06001201 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001202 }
John Zulauff660ad62019-03-23 07:16:05 -06001203
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001204 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1205 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1206 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001207 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1208 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001209 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1210 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1211 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001212 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001213 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001214 if (image_state->shared_presentable) {
1215 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001216 skip |=
1217 LogError(device, layout_invalid_msg_code,
1218 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1219 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001220 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001221 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001222 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001223 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001224 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1225 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1226 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1227 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001228 }
1229 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001230 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001231}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001232bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001233 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1234 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001235 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001236 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1237 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1238}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001239
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001240void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001241 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001242 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001243 if (!renderPass) return;
1244
Tobias Hectorbbb12282018-10-22 15:17:59 +01001245 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001246 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001247 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001248 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001249 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1250 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1251 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1252 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001253 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001254 }
John Zulauf8e308292018-09-21 11:34:37 -06001255 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001256 VkImageLayout stencil_layout = kInvalidLayout;
1257 const auto *attachment_description_stencil_layout =
1258 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1259 if (attachment_description_stencil_layout) {
1260 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1261 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001262 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001263 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001264 }
1265 }
1266}
Dave Houltone19e20d2018-02-02 16:32:41 -07001267
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001268#ifdef VK_USE_PLATFORM_ANDROID_KHR
1269// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1270// This could also move into a seperate core_validation_android.cpp file... ?
1271
1272//
1273// AHB-specific validation within non-AHB APIs
1274//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001275bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001276 bool skip = false;
1277
1278 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1279 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001280 if (0 != ext_fmt_android->externalFormat) {
1281 if (VK_FORMAT_UNDEFINED != create_info->format) {
1282 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001283 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1284 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1285 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001286 }
1287
1288 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001289 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1290 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1291 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001292 }
1293
1294 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001295 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1296 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001297 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1298 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1299 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001300 }
1301
1302 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001303 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1304 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1305 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001306 }
1307 }
1308
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001309 if ((0 != ext_fmt_android->externalFormat) &&
1310 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001311 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001312 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1313 ") which has "
1314 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1315 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001316 }
1317 }
1318
Dave Houltond9611312018-11-19 17:03:36 -07001319 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001320 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001321 skip |=
1322 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1323 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1324 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001325 }
1326 }
1327
1328 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1329 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1330 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001331 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001332 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1333 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1334 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1335 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001336 }
1337
1338 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001339 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1340 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1341 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1342 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1343 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001344 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001345 }
1346
1347 return skip;
1348}
1349
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001350bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001351 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001352 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001353
1354 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001355 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001356 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1357 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001358 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001359 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001360 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001361
Dave Houltond9611312018-11-19 17:03:36 -07001362 // Chain must include a compatible ycbcr conversion
1363 bool conv_found = false;
1364 uint64_t external_format = 0;
1365 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1366 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001367 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001368 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001369 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001370 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001371 }
Dave Houltond9611312018-11-19 17:03:36 -07001372 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001373 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001374 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001375 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1376 "an externalFormat (%" PRIu64
1377 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1378 "with the same external format.",
1379 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001380 }
1381
1382 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001383 if (IsIdentitySwizzle(create_info->components) == false) {
1384 skip |= LogError(
1385 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1386 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1387 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1388 "= %s.",
1389 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1390 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001391 }
1392 }
Dave Houltond9611312018-11-19 17:03:36 -07001393
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001394 return skip;
1395}
1396
John Zulaufa26d3c82019-08-14 16:09:08 -06001397bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001398 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001399
John Zulaufa26d3c82019-08-14 16:09:08 -06001400 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001401 if (image_state != nullptr) {
1402 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1403 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1404 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1405 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1406 "bound to memory.");
1407 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001408 }
1409 return skip;
1410}
1411
1412#else
1413
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001414bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001415 return false;
1416}
1417
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001418bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001419
John Zulaufa26d3c82019-08-14 16:09:08 -06001420bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001421
1422#endif // VK_USE_PLATFORM_ANDROID_KHR
1423
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001424bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1425 bool skip = false;
1426
1427 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1428 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1429 const VkImageTiling image_tiling = pCreateInfo->tiling;
1430 const VkFormat image_format = pCreateInfo->format;
1431
1432 if (image_format == VK_FORMAT_UNDEFINED) {
1433 // VU 01975 states format can't be undefined unless an android externalFormat
1434#ifdef VK_USE_PLATFORM_ANDROID_KHR
1435 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1436 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1437 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1438 if (it != ahb_ext_formats_map.end()) {
1439 tiling_features = it->second;
1440 }
1441 }
1442#endif
1443 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1444 uint64_t drm_format_modifier = 0;
1445 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1446 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1447 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1448 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1449
1450 if (drm_explicit != nullptr) {
1451 drm_format_modifier = drm_explicit->drmFormatModifier;
1452 } else {
1453 // VUID 02261 makes sure its only explict or implict in parameter checking
1454 assert(drm_implicit != nullptr);
1455 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1456 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1457 }
1458 }
1459
1460 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1461 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1462 nullptr};
1463 format_properties_2.pNext = (void *)&drm_properties_list;
1464 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001465 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1466 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1467 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1468 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001469
1470 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1471 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1472 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1473 }
1474 }
1475 } else {
1476 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1477 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1478 : format_properties.optimalTilingFeatures;
1479 }
1480
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001481 // Lack of disjoint format feature support while using the flag
1482 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1483 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1484 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1485 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1486 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1487 string_VkFormat(pCreateInfo->format));
1488 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001489
1490 return skip;
1491}
1492
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001493bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001494 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001495 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001496
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001497 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001498 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001499 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1500 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001501 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1502 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001503 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001504 }
1505
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001506 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1507 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001508 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1509 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1510 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001511 }
1512
1513 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001514 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1515 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1516 "height (%d) and arrayLayers (%d) must be >= 6.",
1517 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001518 }
Dave Houlton130c0212018-01-29 13:39:56 -07001519 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001520
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001521 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001522 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1523 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1524 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001525 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1526 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1527 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001528 }
1529
1530 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001531 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1532 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1533 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001534 }
1535
ByumjinConffx991b6062019-08-14 15:17:53 -07001536 if (device_extensions.vk_ext_fragment_density_map) {
1537 uint32_t ceiling_width =
1538 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1539 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1540 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1541 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001542 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1543 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1544 "ceiling of device "
1545 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1546 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1547 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001548 }
1549
1550 uint32_t ceiling_height =
1551 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1552 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1553 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1554 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001555 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1556 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1557 "ceiling of device "
1558 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1559 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1560 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001561 }
1562 }
1563
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001564 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001565 VkResult result = VK_SUCCESS;
1566 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1567 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1568 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1569 &format_limits);
1570 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001571 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1572 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1573 if (modifier_list) {
1574 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1575 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1576 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1577 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1578 image_format_info.type = pCreateInfo->imageType;
1579 image_format_info.format = pCreateInfo->format;
1580 image_format_info.tiling = pCreateInfo->tiling;
1581 image_format_info.usage = pCreateInfo->usage;
1582 image_format_info.flags = pCreateInfo->flags;
1583 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1584
1585 result =
1586 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1587 format_limits = image_format_properties.imageFormatProperties;
1588
1589 /* The application gives a list of modifier and the driver
1590 * selects one. If one is wrong, stop there.
1591 */
1592 if (result != VK_SUCCESS) break;
1593 }
1594 } else if (explicit_modifier) {
1595 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1596 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1597 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1598 image_format_info.type = pCreateInfo->imageType;
1599 image_format_info.format = pCreateInfo->format;
1600 image_format_info.tiling = pCreateInfo->tiling;
1601 image_format_info.usage = pCreateInfo->usage;
1602 image_format_info.flags = pCreateInfo->flags;
1603 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1604
1605 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1606 format_limits = image_format_properties.imageFormatProperties;
1607 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001608 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001609
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001610 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1611 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1612 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1613 if (result != VK_SUCCESS) {
1614 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001615#ifdef VK_USE_PLATFORM_ANDROID_KHR
1616 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1617#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001618 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001619 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001620 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1621 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001622 } else {
1623 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1624 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001625 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1626 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1627 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001628 }
Dave Houlton130c0212018-01-29 13:39:56 -07001629
Dave Houltona585d132019-01-18 13:05:42 -07001630 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1631 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1632 (uint64_t)pCreateInfo->samples;
1633 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001634
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001635 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001636 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001637 uint64_t ig_mask = imageGranularity - 1;
1638 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001639
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001640 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001641 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1642 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1643 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1644 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001645 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001646
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001647 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001648 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1649 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1650 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001651 }
1652
1653 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001654 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1655 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1656 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001657 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001658
1659 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1660 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1661 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1662 pCreateInfo->extent.width, format_limits.maxExtent.width);
1663 }
1664
1665 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1666 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1667 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1668 pCreateInfo->extent.height, format_limits.maxExtent.height);
1669 }
1670
1671 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1672 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1673 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1674 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1675 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001676 }
1677
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001678 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001679 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1680 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1681 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1682 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001683 skip |= LogError(device, error_vuid,
1684 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1685 "YCbCr Conversion format, arrayLayers must be 1",
1686 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001687 }
1688
1689 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001690 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1691 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1692 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001693 }
1694
1695 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001696 skip |= LogError(
1697 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001698 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1699 string_VkSampleCountFlagBits(pCreateInfo->samples));
1700 }
1701
1702 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001703 skip |= LogError(
1704 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001705 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1706 string_VkImageType(pCreateInfo->imageType));
1707 }
1708 }
1709
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001710 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001711 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001712 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001713 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001714 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1715 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1716 "format must be block, ETC or ASTC compressed, but is %s",
1717 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001718 }
1719 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001720 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1721 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1722 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001723 }
1724 }
1725 }
1726
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001727 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001728 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1729 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1730 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001731 }
1732
unknown2c877272019-07-11 12:56:50 -06001733 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1734 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1735 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001736 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1737 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1738 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001739 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001740
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001741 const auto swapchain_create_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1742 if (swapchain_create_info != nullptr) {
1743 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1744 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1745 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1746
1747 // Validate rest of Swapchain Image create check that require swapchain state
1748 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1749 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1750 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1751 skip |= LogError(
1752 device, vuid,
1753 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1754 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1755 }
1756 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1757 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1758 skip |= LogError(device, vuid,
1759 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1760 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1761 }
1762 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR);
1763 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1764 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1765 skip |= LogError(device, vuid,
1766 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1767 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
1768 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR flags both set.");
1769 }
1770 }
1771 }
1772
sfricke-samsungedce77a2020-07-03 22:35:13 -07001773 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1774 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1775 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1776 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1777 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1778 }
1779 const VkImageCreateFlags invalid_flags =
1780 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1781 if ((pCreateInfo->flags & invalid_flags) != 0) {
1782 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1783 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1784 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1785 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1786 }
1787 }
1788
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001789 skip |= ValidateImageFormatFeatures(pCreateInfo);
1790
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001791 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001792}
1793
John Zulauf7eeb6f72019-06-17 11:56:36 -06001794void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1795 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1796 if (VK_SUCCESS != result) return;
1797
1798 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001799 auto image_state = Get<IMAGE_STATE>(*pImage);
1800 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001801}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001802
Jeff Bolz5c801d12019-10-09 10:38:45 -05001803bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001804 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001805 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001806 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001807 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001808 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001809 }
1810 return skip;
1811}
1812
John Zulauf7eeb6f72019-06-17 11:56:36 -06001813void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1814 // Clean up validation specific data
1815 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001816
locke-lunargcba7d5f2019-12-30 16:59:11 -07001817 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001818
1819 // Clean up generic image state
1820 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001821}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001822
sfricke-samsungcd924d92020-05-20 23:51:17 -07001823bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
1824 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001825 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07001826 const VkImage image = image_state->image;
1827 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001828
1829 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001830 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
1831 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001832 }
1833
sfricke-samsungcd924d92020-05-20 23:51:17 -07001834 if (FormatIsDepthOrStencil(format)) {
1835 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1836 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
1837 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
1838 } else if (FormatIsCompressed(format)) {
1839 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1840 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
1841 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001842 }
1843
1844 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001845 skip |=
1846 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
1847 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
1848 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001849 }
1850 return skip;
1851}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001852
John Zulauf07288512019-07-05 11:09:50 -06001853bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1854 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1855 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001856 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001857 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1858 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001859 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1860 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1861 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001862 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001863
1864 } else {
1865 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1866 if (!device_extensions.vk_khr_shared_presentable_image) {
1867 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001868 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1869 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1870 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001871 }
1872 } else {
1873 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1874 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001875 skip |= LogError(
1876 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001877 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1878 func_name, string_VkImageLayout(dest_image_layout));
1879 }
1880 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001881 }
1882
John Zulauff660ad62019-03-23 07:16:05 -06001883 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001884 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001885 if (subresource_map) {
1886 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001887 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001888 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001889 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1890 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001891 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1892 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1893 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1894 } else {
1895 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001896 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001897 subres_skip |= LogError(cb_node->commandBuffer, error_code,
1898 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1899 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1900 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001901 }
John Zulauf5e617452019-11-19 14:44:16 -07001902 }
John Zulauff660ad62019-03-23 07:16:05 -06001903 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001904 }
1905
1906 return skip;
1907}
1908
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001909bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1910 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001911 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001912 bool skip = false;
1913 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001914 const auto *cb_node = GetCBState(commandBuffer);
1915 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001916 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001917 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001918 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001919 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001920 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001921 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001922 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1923 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001924 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001925 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001926 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001927 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001928 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07001929 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001930 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001931 }
sfricke-samsunge775d492020-02-28 09:02:25 -08001932 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
1933 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
1934 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
1935 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
1936 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
1937 string_VkFormat(image_state->createInfo.format));
1938 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001939 }
1940 return skip;
1941}
1942
John Zulaufeabb4462019-07-05 14:13:03 -06001943void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1944 const VkClearColorValue *pColor, uint32_t rangeCount,
1945 const VkImageSubresourceRange *pRanges) {
1946 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1947
1948 auto cb_node = GetCBState(commandBuffer);
1949 auto image_state = GetImageState(image);
1950 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001951 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001952 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001953 }
1954 }
1955}
1956
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001957bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1958 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001959 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001960 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001961
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001962 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001963 const auto *cb_node = GetCBState(commandBuffer);
1964 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001965 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001966 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001967 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001968 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001969 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001970 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07001971 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001972 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001973 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001974 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001975 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001976
1977 bool any_include_aspect_depth_bit = false;
1978 bool any_include_aspect_stencil_bit = false;
1979
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001980 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001981 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001982 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001983 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001984 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001985 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1986 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001987 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
1988 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
1989 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
1990 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001991 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001992 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1993 any_include_aspect_depth_bit = true;
1994 }
1995 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1996 any_include_aspect_stencil_bit = true;
1997 }
1998 }
1999 if (any_include_aspect_stencil_bit) {
2000 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2001 if (image_stencil_struct != nullptr) {
2002 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2003 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002004 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2005 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2006 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2007 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002008 }
2009 } else {
2010 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002011 skip |= LogError(
2012 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002013 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2014 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2015 "in VkImageCreateInfo::usage used to create image");
2016 }
2017 }
2018 }
2019 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002020 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2021 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2022 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002023 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06002024 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002025 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2026 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
2027 report_data->FormatHandle(image).c_str(), string_VkFormat(image_state->createInfo.format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002028 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002029 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002030 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2031 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2032 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2033 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002034 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002035 }
2036 return skip;
2037}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002038
John Zulaufeabb4462019-07-05 14:13:03 -06002039void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2040 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2041 const VkImageSubresourceRange *pRanges) {
2042 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2043 auto cb_node = GetCBState(commandBuffer);
2044 auto image_state = GetImageState(image);
2045 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002046 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002047 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002048 }
2049 }
2050}
2051
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002052// Returns true if [x, xoffset] and [y, yoffset] overlap
2053static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2054 bool result = false;
2055 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2056 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2057
2058 if (intersection_max > intersection_min) {
2059 result = true;
2060 }
2061 return result;
2062}
2063
Dave Houltonc991cc92018-03-06 11:08:51 -07002064// Returns true if source area of first copy region intersects dest area of second region
2065// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2066static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002067 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002068
Dave Houltonc991cc92018-03-06 11:08:51 -07002069 // Separate planes within a multiplane image cannot intersect
2070 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002071 return result;
2072 }
2073
Dave Houltonc991cc92018-03-06 11:08:51 -07002074 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2075 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2076 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002077 result = true;
2078 switch (type) {
2079 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002080 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002081 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002082 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002083 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002084 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002085 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002086 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002087 break;
2088 default:
2089 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2090 assert(false);
2091 }
2092 }
2093 return result;
2094}
2095
Dave Houltonfc1a4052017-04-27 14:32:45 -06002096// Returns non-zero if offset and extent exceed image extents
2097static const uint32_t x_bit = 1;
2098static const uint32_t y_bit = 2;
2099static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002100static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002101 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002102 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002103 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2104 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002105 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002106 }
2107 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2108 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002109 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002110 }
2111 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2112 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002113 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002114 }
2115 return result;
2116}
2117
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002118// Test if two VkExtent3D structs are equivalent
2119static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2120 bool result = true;
2121 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2122 (extent->depth != other_extent->depth)) {
2123 result = false;
2124 }
2125 return result;
2126}
2127
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002128// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002129static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002130 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2131}
2132
2133// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002134VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002135 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2136 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002137 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002138 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002139 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002140 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002141 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002142 granularity.width *= block_size.width;
2143 granularity.height *= block_size.height;
2144 }
2145 }
2146 return granularity;
2147}
2148
2149// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2150static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2151 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002152 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2153 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002154 valid = false;
2155 }
2156 return valid;
2157}
2158
2159// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002160bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002161 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002162 bool skip = false;
2163 VkExtent3D offset_extent = {};
2164 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2165 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2166 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002167 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002168 // 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 -07002169 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002170 skip |= LogError(cb_node->commandBuffer, vuid,
2171 "%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 "
2172 "image transfer granularity is (w=0, h=0, d=0).",
2173 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002174 }
2175 } else {
2176 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2177 // integer multiples of the image transfer granularity.
2178 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002179 skip |= LogError(cb_node->commandBuffer, vuid,
2180 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2181 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2182 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2183 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002184 }
2185 }
2186 return skip;
2187}
2188
2189// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002190bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002191 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002192 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002193 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002194 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002195 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2196 // subresource extent.
2197 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002198 skip |= LogError(cb_node->commandBuffer, vuid,
2199 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2200 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2201 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2202 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002203 }
2204 } else {
2205 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2206 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2207 // subresource extent dimensions.
2208 VkExtent3D offset_extent_sum = {};
2209 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2210 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2211 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002212 bool x_ok = true;
2213 bool y_ok = true;
2214 bool z_ok = true;
2215 switch (image_type) {
2216 case VK_IMAGE_TYPE_3D:
2217 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2218 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002219 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002220 case VK_IMAGE_TYPE_2D:
2221 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2222 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002223 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002224 case VK_IMAGE_TYPE_1D:
2225 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2226 (subresource_extent->width == offset_extent_sum.width));
2227 break;
2228 default:
2229 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2230 assert(false);
2231 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002232 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002233 skip |=
2234 LogError(cb_node->commandBuffer, vuid,
2235 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2236 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2237 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2238 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2239 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2240 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002241 }
2242 }
2243 return skip;
2244}
2245
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002246bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002247 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002248 bool skip = false;
2249 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002250 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2251 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002252 }
2253 return skip;
2254}
2255
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002256bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002257 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002258 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002259 bool skip = false;
2260 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2261 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002262 skip |= LogError(cb_node->commandBuffer, vuid,
2263 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2264 "%u, but provided %s has %u array layers.",
2265 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2266 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002267 }
2268 return skip;
2269}
2270
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002271// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002272bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002273 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002274 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002275 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002276 VkExtent3D granularity = GetScaledItg(cb_node, img);
2277 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002278 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002279 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002280 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002281 return skip;
2282}
2283
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002284// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002285bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002286 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002287 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002288 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002289 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002290 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2291 skip |=
2292 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002293 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002294 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002295 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2296 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002297
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002298 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002299 granularity = GetScaledItg(cb_node, dst_img);
2300 skip |=
2301 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002302 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002303 const VkExtent3D dest_effective_extent =
2304 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002305 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002306 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002307 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002308 return skip;
2309}
2310
Dave Houlton6f9059e2017-05-02 17:15:13 -06002311// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002312bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002313 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002314 bool skip = false;
2315
2316 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002317 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002318
2319 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002320 const VkExtent3D src_copy_extent = region.extent;
2321 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002322 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2323
Dave Houlton6f9059e2017-05-02 17:15:13 -06002324 bool slice_override = false;
2325 uint32_t depth_slices = 0;
2326
2327 // Special case for copying between a 1D/2D array and a 3D image
2328 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2329 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002330 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002331 slice_override = (depth_slices != 1);
2332 } 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 -07002333 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002334 slice_override = (depth_slices != 1);
2335 }
2336
2337 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002338 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002339 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002340 skip |=
2341 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00146",
2342 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2343 "be 0 and 1, respectively.",
2344 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002345 }
2346 }
2347
Dave Houlton533be9f2018-03-26 17:08:30 -06002348 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 -07002349 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01785",
2350 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2351 "these must be 0 and 1, respectively.",
2352 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002353 }
2354
Dave Houlton533be9f2018-03-26 17:08:30 -06002355 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002356 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-01787",
2357 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2358 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002359 }
2360
Dave Houltonc991cc92018-03-06 11:08:51 -07002361 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002362 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002363 if (FormatIsCompressed(src_state->createInfo.format) ||
2364 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002365 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002366 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002367 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2368 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2369 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002370 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002371 skip |= LogError(src_state->image, vuid,
2372 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2373 "texel width & height (%d, %d).",
2374 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002375 }
2376
Dave Houlton94a00372017-12-14 15:08:47 -07002377 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002378 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2379 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002380 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002381 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002382 LogError(src_state->image, vuid,
2383 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2384 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2385 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002386 }
2387
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002388 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002389 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2390 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002391 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002392 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002393 LogError(src_state->image, vuid,
2394 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2395 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2396 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002397 }
2398
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002399 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002400 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2401 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002402 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002403 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002404 LogError(src_state->image, vuid,
2405 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2406 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2407 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002408 }
2409 } // Compressed
2410
2411 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002412 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002413 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002414 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-00152",
2415 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2416 "these must be 0 and 1, respectively.",
2417 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002418 }
2419 }
2420
Dave Houlton533be9f2018-03-26 17:08:30 -06002421 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 -07002422 skip |=
2423 LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01786",
2424 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2425 "and 1, respectively.",
2426 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002427 }
2428
Dave Houlton533be9f2018-03-26 17:08:30 -06002429 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002430 skip |= LogError(dst_state->image, "VUID-VkImageCopy-dstImage-01788",
2431 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2432 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002433 }
2434
sfricke-samsung30b094c2020-05-30 11:42:11 -07002435 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002436 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002437 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2438 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
2439 skip |=
2440 LogError(src_state->image, "VUID-VkImageCopy-srcImage-00141",
2441 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2442 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2443 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2444 }
2445 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002446 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002447 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002448 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002449 LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00141",
2450 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2451 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2452 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002453 }
2454 }
2455 } else { // Pre maint 1
2456 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002457 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
2458 skip |= LogError(src_state->image, "VUID-VkImageCopy-srcImage-00139",
2459 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2460 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2461 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2462 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2463 }
Dave Houltonee281a52017-12-08 13:51:02 -07002464 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002465 skip |= LogError(dst_state->image, "VUID-VkImageCopy-srcImage-00139",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002466 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2467 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2468 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2469 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002470 }
2471 }
2472 }
2473
Dave Houltonc991cc92018-03-06 11:08:51 -07002474 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2475 if (FormatIsCompressed(dst_state->createInfo.format) ||
2476 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002477 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002478
2479 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002480 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2481 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2482 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002483 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002484 skip |= LogError(dst_state->image, vuid,
2485 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2486 "texel width & height (%d, %d).",
2487 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002488 }
2489
Dave Houlton94a00372017-12-14 15:08:47 -07002490 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002491 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2492 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002493 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002494 skip |= LogError(
2495 dst_state->image, vuid,
2496 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2497 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2498 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002499 }
2500
Dave Houltonee281a52017-12-08 13:51:02 -07002501 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2502 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2503 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002504 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002505 skip |= LogError(dst_state->image, vuid,
2506 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2507 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2508 "height (%d).",
2509 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002510 }
2511
Dave Houltonee281a52017-12-08 13:51:02 -07002512 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2513 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2514 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002515 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002516 skip |= LogError(
2517 dst_state->image, vuid,
2518 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2519 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2520 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002521 }
2522 } // Compressed
2523 }
2524 return skip;
2525}
2526
Dave Houltonc991cc92018-03-06 11:08:51 -07002527// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002528bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002529 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002530 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002531
2532 // Neither image is multiplane
2533 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2534 // If neither image is multi-plane the aspectMask member of src and dst must match
2535 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2536 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002537 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002538 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002539 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002540 }
2541 } else {
2542 // Source image multiplane checks
2543 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2544 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2545 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2546 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002547 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002548 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002549 }
2550 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2551 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2552 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002553 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002554 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002555 }
2556 // Single-plane to multi-plane
2557 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2558 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2559 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002560 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002561 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002562 }
2563
2564 // Dest image multiplane checks
2565 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2566 aspect = region.dstSubresource.aspectMask;
2567 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2568 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002569 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002570 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002571 }
2572 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2573 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2574 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002575 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002576 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002577 }
2578 // Multi-plane to single-plane
2579 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2580 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2581 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002582 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002583 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002584 }
2585 }
2586
2587 return skip;
2588}
2589
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002590bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2591 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002592 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002593 const auto *cb_node = GetCBState(commandBuffer);
2594 const auto *src_image_state = GetImageState(srcImage);
2595 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002596 const VkFormat src_format = src_image_state->createInfo.format;
2597 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002598 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002599
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002600 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002601
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002602 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2603
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002604 for (uint32_t i = 0; i < regionCount; i++) {
2605 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002606
2607 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2608 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002609 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002610
Dave Houlton6f9059e2017-05-02 17:15:13 -06002611 bool slice_override = false;
2612 uint32_t depth_slices = 0;
2613
2614 // Special case for copying between a 1D/2D array and a 3D image
2615 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2616 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2617 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002618 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002619 slice_override = (depth_slices != 1);
2620 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2621 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002622 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002623 slice_override = (depth_slices != 1);
2624 }
2625
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002626 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2627 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2628 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002629 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002630 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002631 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002632 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002633 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2634 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002635 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002636 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2637 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002638
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002639 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002640 // No chance of mismatch if we're overriding depth slice count
2641 if (!slice_override) {
2642 // The number of depth slices in srcSubresource and dstSubresource must match
2643 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2644 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002645 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2646 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002647 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002648 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2649 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002650 if (src_slices != dst_slices) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002651 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140",
2652 "vkCmdCopyImage(): number of depth slices in source and destination subresources for "
2653 "pRegions[%u] do not match.",
2654 i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002655 }
2656 }
2657 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002658 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002659 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002660 skip |= LogError(
2661 command_buffer, "VUID-VkImageCopy-layerCount-00138",
2662 "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[%u] do not match", i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002663 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002664 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002665
Dave Houltonc991cc92018-03-06 11:08:51 -07002666 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002667 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002668 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002669 }
2670
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002671 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002672 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2673 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002674 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002675 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002676 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002677 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002678
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002679 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002680 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002681 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002682 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002683 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002684 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002685 }
2686
2687 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002688 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002689 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002690 ss << "vkCmdCopyImage(): pRegion[" << i
2691 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002692 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002693 }
2694
Dave Houltonfc1a4052017-04-27 14:32:45 -06002695 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002696 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2697 if (slice_override) src_copy_extent.depth = depth_slices;
2698 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002699 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002700 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002701 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00144",
2702 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2703 "width [%1d].",
2704 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002705 }
2706
2707 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002708 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002709 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00145",
2710 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2711 "height [%1d].",
2712 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002713 }
2714 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002715 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002716 LogError(command_buffer, "VUID-VkImageCopy-srcOffset-00147",
2717 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2718 "depth [%1d].",
2719 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002720 }
2721
Dave Houltonee281a52017-12-08 13:51:02 -07002722 // Adjust dest extent if necessary
2723 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2724 if (slice_override) dst_copy_extent.depth = depth_slices;
2725
2726 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002727 if (extent_check & x_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002728 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00150",
2729 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2730 "width [%1d].",
2731 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002732 }
2733 if (extent_check & y_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002734 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00151",
2735 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2736 "height [%1d].",
2737 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002738 }
2739 if (extent_check & z_bit) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002740 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstOffset-00153",
2741 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2742 "depth [%1d].",
2743 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002744 }
2745
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002746 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2747 // must not overlap in memory
2748 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002749 for (uint32_t j = 0; j < regionCount; j++) {
2750 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002751 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002752 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002753 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002754 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002755 }
2756 }
2757 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002758
2759 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2760 if (device_extensions.vk_khr_maintenance1) {
2761 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2762 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2763 (src_copy_extent.depth != 1)) {
2764 skip |= LogError(
2765 command_buffer, "VUID-VkImageCopy-srcImage-01790",
2766 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2767 src_copy_extent.depth);
2768 }
2769 } else {
2770 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2771 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2772 (src_copy_extent.depth != 1)) {
2773 skip |= LogError(
2774 command_buffer, "VUID-VkImageCopy-srcImage-01789",
2775 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2776 src_copy_extent.depth);
2777 }
2778 }
2779
2780 // Check if 2D with 3D and depth not equal to 2D layerCount
2781 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2782 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2783 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
2784 skip |= LogError(command_buffer, "VUID-VkImageCopy-srcImage-01791",
2785 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2786 "srcSubresource.layerCount (%u)",
2787 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2788 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2789 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2790 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
2791 skip |= LogError(command_buffer, "VUID-VkImageCopy-dstImage-01792",
2792 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2793 "dstSubresource.layerCount (%u)",
2794 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2795 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002796
2797 // Check for multi-plane format compatiblity
2798 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
2799 size_t src_format_size = 0;
2800 size_t dst_format_size = 0;
2801 if (FormatIsMultiplane(src_format)) {
2802 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
2803 src_format_size = FormatElementSize(planeFormat);
2804 } else {
2805 src_format_size = FormatElementSize(src_format);
2806 }
2807 if (FormatIsMultiplane(dst_format)) {
2808 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
2809 dst_format_size = FormatElementSize(planeFormat);
2810 } else {
2811 dst_format_size = FormatElementSize(dst_format);
2812 }
2813 // If size is still zero, then format is invalid and will be caught in another VU
2814 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
2815 skip |=
2816 LogError(command_buffer, "VUID-vkCmdCopyImage-None-01549",
2817 "vkCmdCopyImage(): pRegions[%u] called with non-compatible image formats. "
2818 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
2819 i, string_VkFormat(src_format), string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(),
2820 string_VkFormat(dst_format), string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
2821 }
2822 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002823 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002824
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002825 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
2826 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
2827 // because because both texels are 4 bytes in size.
2828 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
2829 const char *compatible_vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2830 : "VUID-vkCmdCopyImage-srcImage-00135";
2831 // Depth/stencil formats must match exactly.
2832 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2833 if (src_format != dst_format) {
2834 skip |= LogError(command_buffer, compatible_vuid,
2835 "vkCmdCopyImage(): Depth/stencil formats must match exactly for src (%s) and dst (%s).",
2836 string_VkFormat(src_format), string_VkFormat(dst_format));
2837 }
2838 } else {
2839 if (!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) {
2840 skip |= LogError(command_buffer, compatible_vuid,
2841 "vkCmdCopyImage(): Unmatched image format sizes. "
2842 "The src format %s has size of %zu and dst format %s has size of %zu.",
2843 string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
2844 FormatElementSize(dst_format));
2845 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002846 }
2847 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002848
Dave Houlton33c22b72017-02-28 13:16:02 -07002849 // Source and dest image sample counts must match
2850 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2851 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002852 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002853 }
2854
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002855 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2856 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002857 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002858 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2859 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2860 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2861 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02002862
2863 // Validation for VK_EXT_fragment_density_map
2864 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2865 skip |= LogError(
2866 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2867 "vkCmdCopyImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2868 }
2869 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2870 skip |= LogError(
2871 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2872 "vkCmdCopyImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2873 }
2874
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002875 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002876 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002877 "VUID-vkCmdCopyImage-srcImage-01995");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002878 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002879 "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002880 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002881 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002882 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002883 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2884 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002885 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002886 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2887 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2888 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2889 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2890 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2891 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002892 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002893 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002894 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2895 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002896 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002897 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2898 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002899 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2900 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002901 }
2902
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002903 return skip;
2904}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002905
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002906void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2907 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2908 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002909 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2910 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002911 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002912 auto src_image_state = GetImageState(srcImage);
2913 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002914
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002915 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002916 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002917 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2918 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002919 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002920}
2921
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002922// Returns true if sub_rect is entirely contained within rect
2923static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2924 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2925 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2926 return false;
2927 return true;
2928}
2929
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002930bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002931 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2932 const VkRect2D &render_area, uint32_t rect_count,
2933 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002934 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002935 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2936 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06002937 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07002938 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002939
2940 for (uint32_t j = 0; j < rect_count; j++) {
2941 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002942 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
2943 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2944 "the current render pass instance.",
2945 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07002946 }
2947
2948 if (image_view_state) {
2949 // The layers specified by a given element of pRects must be contained within every attachment that
2950 // pAttachments refers to
2951 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2952 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2953 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002954 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
2955 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2956 "of pAttachment[%d].",
2957 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002958 }
2959 }
2960 }
2961 return skip;
2962}
2963
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002964bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2965 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002966 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002967 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002968 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002969 if (!cb_node) return skip;
2970
2971 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2972 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2973 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002974 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002975
2976 // Validate that attachment is in reference list of active subpass
2977 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002978 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002979 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002980 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002981 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002982 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002983
John Zulauf3a548ef2019-02-01 16:14:07 -07002984 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2985 auto clear_desc = &pAttachments[attachment_index];
2986 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002987
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002988 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002989 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002990 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002991 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002992 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002993 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2994 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2995 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2996 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002997 skip |= LogError(
2998 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
2999 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3000 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3001 attachment_index, clear_desc->colorAttachment,
3002 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3003 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003004
John Zulauff2582972019-02-09 14:53:30 -07003005 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3006 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003007 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003008 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3009 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3010 " subpass %u. colorAttachmentCount=%u",
3011 attachment_index, clear_desc->colorAttachment,
3012 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3013 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003014 }
John Zulauff2582972019-02-09 14:53:30 -07003015 fb_attachment = color_attachment;
3016
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003017 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3018 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3019 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003020 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003021 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003022 }
3023 } else { // Must be depth and/or stencil
3024 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
3025 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003026 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003027 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003028 }
3029 if (!subpass_desc->pDepthStencilAttachment ||
3030 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003031 skip |= LogPerformanceWarning(
3032 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003033 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003034 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003035 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003036 }
3037 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003038 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003039 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3040 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003041 }
3042 }
3043 }
3044 return skip;
3045}
3046
3047void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3048 const VkClearAttachment *pAttachments, uint32_t rectCount,
3049 const VkClearRect *pRects) {
3050 auto *cb_node = GetCBState(commandBuffer);
3051 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3052 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3053 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3054 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3055 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3056 const auto clear_desc = &pAttachments[attachment_index];
3057 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3058 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3059 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3060 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3061 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3062 subpass_desc->pDepthStencilAttachment) {
3063 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3064 }
3065 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003066 if (!clear_rect_copy) {
3067 // We need a copy of the clear rectangles that will persist until the last lambda executes
3068 // but we want to create it as lazily as possible
3069 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003070 }
John Zulauf441558b2019-08-12 11:47:39 -06003071 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3072 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003073 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003074 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003075 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003076 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003077 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3078 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003079 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3080 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003081 return skip;
3082 };
3083 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003084 }
3085 }
3086 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003087}
3088
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003089bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3090 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003091 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003092 const auto *cb_node = GetCBState(commandBuffer);
3093 const auto *src_image_state = GetImageState(srcImage);
3094 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003095
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003096 bool skip = false;
3097 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003098 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3099 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003100 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003101 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003102 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3103 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003104 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003105 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003106
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003107 // Validation for VK_EXT_fragment_density_map
3108 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3109 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3110 "vkCmdResolveImage(): srcImage must not have been created with flags containing "
3111 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3112 }
3113 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3114 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3115 "vkCmdResolveImage(): dstImage must not have been created with flags containing "
3116 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3117 }
3118
Cort Stratton7df30962018-05-17 19:45:57 -07003119 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003120 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003121 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003122 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3123 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3124 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003125 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003126 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3127 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003128 // For each region, the number of layers in the image subresource should not be zero
3129 // For each region, src and dest image aspect must be color only
3130 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003131 const VkImageSubresourceLayers src_subresource = pRegions[i].srcSubresource;
3132 const VkImageSubresourceLayers dst_subresource = pRegions[i].dstSubresource;
3133 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, "vkCmdResolveImage()", "srcSubresource", i);
3134 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, "vkCmdResolveImage()", "dstSubresource", i);
3135 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003136 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3137 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003138 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003139 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3140 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003141 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003142 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003143 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003144 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003145 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
3146 src_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003147 "VUID-vkCmdResolveImage-srcSubresource-01711");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003148 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
3149 dst_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003150 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003151
3152 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003153 if (src_subresource.layerCount != dst_subresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003154 skip |= LogError(
3155 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003156 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%u] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003157 }
Cort Stratton7df30962018-05-17 19:45:57 -07003158 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003159 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3160 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3161 skip |= LogError(
3162 cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266",
3163 "vkCmdResolveImage(): src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3164 i);
3165 }
3166
3167 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3168 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3169
3170 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
3171 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount) ||
3172 (0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3173 LogObjectList objlist(cb_node->commandBuffer);
3174 objlist.add(src_image_state->image);
3175 objlist.add(dst_image_state->image);
3176 skip |= LogError(objlist, "VUID-VkImageResolve-srcImage-00268",
3177 "vkCmdResolveImage(): pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
3178 "subresources if the src or dst image is 3D.",
3179 i);
3180 }
3181 }
3182
3183 if (VK_IMAGE_TYPE_1D == src_image_type) {
3184 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3185 LogObjectList objlist(cb_node->commandBuffer);
3186 objlist.add(src_image_state->image);
3187 skip |= LogError(objlist, "VUID-VkImageResolve-srcImage-00271",
3188 "vkCmdResolveImage(): srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
3189 "extent.height (%u) is not 1.",
3190 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.y,
3191 pRegions[i].extent.height);
3192 }
3193 }
3194 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3195 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3196 LogObjectList objlist(cb_node->commandBuffer);
3197 objlist.add(src_image_state->image);
3198 skip |= LogError(objlist, "VUID-VkImageResolve-srcImage-00273",
3199 "vkCmdResolveImage(): srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
3200 "extent.depth (%u) is not 1.",
3201 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.z,
3202 pRegions[i].extent.depth);
3203 }
3204 }
3205
3206 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3207 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3208 LogObjectList objlist(cb_node->commandBuffer);
3209 objlist.add(dst_image_state->image);
3210 skip |= LogError(objlist, "VUID-VkImageResolve-dstImage-00276",
3211 "vkCmdResolveImage(): dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
3212 "extent.height (%u) is not 1.",
3213 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.y,
3214 pRegions[i].extent.height);
3215 }
3216 }
3217 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3218 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3219 LogObjectList objlist(cb_node->commandBuffer);
3220 objlist.add(dst_image_state->image);
3221 skip |= LogError(objlist, "VUID-VkImageResolve-dstImage-00278",
3222 "vkCmdResolveImage(): dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
3223 "extent.depth (%u) is not 1.",
3224 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.z,
3225 pRegions[i].extent.depth);
3226 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003227 }
3228 }
3229
3230 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003231 skip |=
3232 LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-01386",
3233 "vkCmdResolveImage(): srcImage format (%s) and dstImage format (%s) are not the same.",
3234 string_VkFormat(src_image_state->createInfo.format), string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003235 }
3236 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003237 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
3238 "vkCmdResolveImage(): srcImage type (%s) and dstImage type (%s) are not the same.",
3239 string_VkImageType(src_image_state->createInfo.imageType),
3240 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003241 }
3242 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003243 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257",
3244 "vkCmdResolveImage(): srcImage sample count is VK_SAMPLE_COUNT_1_BIT.");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003245 }
3246 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003247 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259",
3248 "vkCmdResolveImage(): dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3249 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003250 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003251 } else {
3252 assert(0);
3253 }
3254 return skip;
3255}
3256
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003257bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3258 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003259 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003260 const auto *cb_node = GetCBState(commandBuffer);
3261 const auto *src_image_state = GetImageState(srcImage);
3262 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003263
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003264 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003265 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003266 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003267 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003268 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003269 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003270 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003271 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003272 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003273 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3274 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003275 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003276 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3277 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003278 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003279 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3280 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003281 skip |=
3282 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003283 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3284 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003285 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003286 "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003287 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003288 "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003289
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003290 // Validation for VK_EXT_fragment_density_map
3291 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3292 skip |= LogError(
3293 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3294 "vkCmdBlitImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3295 }
3296 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3297 skip |= LogError(
3298 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3299 "vkCmdBlitImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3300 }
3301
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003302 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003303
Dave Houlton33c2d252017-06-09 17:08:32 -06003304 VkFormat src_format = src_image_state->createInfo.format;
3305 VkFormat dst_format = dst_image_state->createInfo.format;
3306 VkImageType src_type = src_image_state->createInfo.imageType;
3307 VkImageType dst_type = dst_image_state->createInfo.imageType;
3308
Cort Stratton186b1a22018-05-01 20:18:06 -04003309 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003310 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003311 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003312 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003313 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003314 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003315 }
3316
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003317 if (FormatRequiresYcbcrConversion(src_format)) {
3318 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3319 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3320 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3321 string_VkFormat(src_format));
3322 }
3323
3324 if (FormatRequiresYcbcrConversion(dst_format)) {
3325 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3326 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3327 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3328 string_VkFormat(dst_format));
3329 }
3330
Dave Houlton33c2d252017-06-09 17:08:32 -06003331 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003332 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3333 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003334 }
3335
Dave Houlton33c2d252017-06-09 17:08:32 -06003336 // Validate consistency for unsigned formats
3337 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3338 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003339 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003340 << "the other one must also have unsigned integer format. "
3341 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003342 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003343 }
3344
3345 // Validate consistency for signed formats
3346 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3347 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003348 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003349 << "the other one must also have signed integer format. "
3350 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003351 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003352 }
3353
3354 // Validate filter for Depth/Stencil formats
3355 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3356 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003357 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003358 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003359 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003360 }
3361
3362 // Validate aspect bits and formats for depth/stencil images
3363 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3364 if (src_format != dst_format) {
3365 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003366 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003367 << "stencil, the other one must have exactly the same format. "
3368 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3369 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003370 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003371 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003372 } // Depth or Stencil
3373
3374 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003375 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003376 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003377 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3378 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3379 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003380 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003381 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3382 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003383 for (uint32_t i = 0; i < regionCount; i++) {
3384 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003385 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003386 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003387 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3388 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003389 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003390 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3391 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003392 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3393 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3394 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003395 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003396 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003397 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003398 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003399 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3400 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003401 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003402 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3403 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003404 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003405 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3406 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003407 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003408 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003409 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003410 }
Dave Houlton48989f32017-05-26 15:01:46 -06003411 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3412 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003413 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003414 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003415 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003416 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003417
3418 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003419 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003420 skip |= LogError(
3421 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003422 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003423 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003424
Dave Houlton48989f32017-05-26 15:01:46 -06003425 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003426 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3427 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003428 }
Dave Houlton48989f32017-05-26 15:01:46 -06003429
Dave Houlton33c2d252017-06-09 17:08:32 -06003430 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003431 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00241",
3432 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3433 "image format %s.",
3434 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003435 }
3436
3437 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003438 skip |= LogError(
3439 cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003440 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3441 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003442 }
3443
Dave Houlton48989f32017-05-26 15:01:46 -06003444 // Validate source image offsets
3445 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003446 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003447 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003448 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003449 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00245",
3450 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3451 "of (%1d, %1d). These must be (0, 1).",
3452 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003453 }
3454 }
3455
Dave Houlton33c2d252017-06-09 17:08:32 -06003456 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003457 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003458 skip |=
3459 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00247",
3460 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3461 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3462 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003463 }
3464 }
3465
Dave Houlton33c2d252017-06-09 17:08:32 -06003466 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003467 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3468 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003469 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003470 skip |= LogError(
3471 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003472 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3473 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003474 }
3475 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3476 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003477 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003478 skip |= LogError(
3479 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003480 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003481 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003482 }
3483 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3484 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003485 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003486 skip |= LogError(
3487 cb_node->commandBuffer, "VUID-VkImageBlit-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003488 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3489 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003490 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003491 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003492 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3493 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003494 }
Dave Houlton48989f32017-05-26 15:01:46 -06003495
3496 // Validate dest image offsets
3497 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003498 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003499 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003500 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003501 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00250",
3502 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3503 "(%1d, %1d). These must be (0, 1).",
3504 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003505 }
3506 }
3507
Dave Houlton33c2d252017-06-09 17:08:32 -06003508 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003509 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003510 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-dstImage-00252",
3511 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3512 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3513 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003514 }
3515 }
3516
Dave Houlton33c2d252017-06-09 17:08:32 -06003517 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003518 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3519 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003520 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003521 skip |= LogError(
3522 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003523 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3524 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003525 }
3526 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3527 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003528 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003529 skip |= LogError(
3530 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003531 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003532 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003533 }
3534 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3535 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003536 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003537 skip |= LogError(
3538 cb_node->commandBuffer, "VUID-VkImageBlit-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003539 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3540 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003541 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003542 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003543 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3544 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003545 }
3546
Dave Houlton33c2d252017-06-09 17:08:32 -06003547 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3548 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3549 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003550 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003551 LogError(cb_node->commandBuffer, "VUID-VkImageBlit-srcImage-00240",
3552 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3553 "layerCount other than 1.",
3554 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003555 }
3556 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003557 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003558 } else {
3559 assert(0);
3560 }
3561 return skip;
3562}
3563
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003564void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3565 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3566 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003567 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3568 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003569 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003570 auto src_image_state = GetImageState(srcImage);
3571 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003572
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003573 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003574 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003575 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3576 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003577 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003578}
3579
John Zulauf2076e812020-01-08 14:55:54 -07003580GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3581 assert(map);
3582 // This approach allows for a single hash lookup or/create new
3583 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3584 if (inserted.second) {
3585 assert(nullptr == inserted.first->second.get());
3586 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.range_encoder.SubresourceCount());
3587 inserted.first->second.reset(layout_map);
3588 return layout_map;
3589 } else {
3590 assert(nullptr != inserted.first->second.get());
3591 return inserted.first->second.get();
3592 }
3593 return nullptr;
3594}
3595
3596const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3597 auto it = map.find(image);
3598 if (it != map.end()) {
3599 return it->second.get();
3600 }
3601 return nullptr;
3602}
3603
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003604// 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 -07003605bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3606 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06003607 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003608 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003609 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003610 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003611 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003612 for (const auto &layout_map_entry : pCB->image_layout_map) {
3613 const auto image = layout_map_entry.first;
3614 const auto *image_state = GetImageState(image);
3615 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003616 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003617 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003618 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003619 if (initial_layout_map.empty()) continue;
3620
3621 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3622 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3623 if (global_map == nullptr) {
3624 global_map = &empty_map;
3625 }
3626
3627 // Note: don't know if it would matter
3628 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3629
3630 auto pos = initial_layout_map.begin();
3631 const auto end = initial_layout_map.end();
3632 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3633 pos->first.begin);
3634 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003635 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003636 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003637 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 -07003638 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003639 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003640 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003641 image_layout = current_layout->pos_B->lower_bound->second;
3642 }
3643 const auto intersected_range = pos->first & current_layout->range;
3644 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3645 // TODO: Set memory invalid which is in mem_tracker currently
3646 } else if (image_layout != initial_layout) {
3647 // Need to look up the inital layout *state* to get a bit more information
3648 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3649 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3650 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3651 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07003652 // We can report all the errors for the intersected range directly
3653 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
3654 const auto subresource = image_state->range_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003655 skip |= LogError(
3656 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003657 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003658 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07003659 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003660 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06003661 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003662 }
3663 }
John Zulauf2076e812020-01-08 14:55:54 -07003664 if (pos->first.includes(intersected_range.end)) {
3665 current_layout.seek(intersected_range.end);
3666 } else {
3667 ++pos;
3668 if (pos != end) {
3669 current_layout.seek(pos->first.begin);
3670 }
3671 }
John Zulauff660ad62019-03-23 07:16:05 -06003672 }
3673
locke-lunargf155ccf2020-02-18 11:34:15 -07003674 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003675 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003676 }
John Zulauff660ad62019-03-23 07:16:05 -06003677
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003678 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003679}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003680
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003681void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003682 for (const auto &layout_map_entry : pCB->image_layout_map) {
3683 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003684 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003685 const auto *image_state = GetImageState(image);
3686 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003687 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3688 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003689 }
3690}
3691
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003692// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003693// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3694// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003695bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3696 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003697 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003698 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003699 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3700
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003701 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07003702 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
3703 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003704 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003705 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3706 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3707 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003708 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003709 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003710 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07003711 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3712 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
3713 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003714 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003715 string_VkImageLayout(first_layout));
3716 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3717 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003718 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003719 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003720 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003721 }
3722 }
sfricke-samsung55f01952020-03-24 08:16:41 -07003723
3724 // Same as above for loadOp, but for stencilLoadOp
3725 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3726 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3727 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3728 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
3729 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003730 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003731 string_VkImageLayout(first_layout));
3732 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3733 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
3734 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003735 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003736 string_VkImageLayout(first_layout));
3737 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3738 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3739 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003740 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003741 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003742 }
3743 }
3744
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003745 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003746}
3747
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003748bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3749 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003750 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003751 const char *vuid;
3752 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003753
Jason Ekstranda1906302017-12-03 20:16:32 -08003754 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3755 VkFormat format = pCreateInfo->pAttachments[i].format;
3756 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3757 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3758 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003759 skip |= LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003760 "%s: Render pass pAttachment[%u] has loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003761 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3762 "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 -07003763 "render pass.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003764 function_name, i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003765 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003766 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003767 skip |=
3768 LogWarning(device, kVUID_Core_DrawState_InvalidRenderpass,
3769 "%s: Render pass pAttachment[%u] has stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3770 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3771 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3772 "render pass.",
3773 function_name, i);
Jason Ekstranda1906302017-12-03 20:16:32 -08003774 }
3775 }
3776 }
3777
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003778 // Track when we're observing the first use of an attachment
3779 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3780 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003781 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003782
3783 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3784 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3785 auto attach_index = subpass.pInputAttachments[j].attachment;
3786 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003787 switch (subpass.pInputAttachments[j].layout) {
3788 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3789 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3790 // These are ideal.
3791 break;
3792
3793 case VK_IMAGE_LAYOUT_GENERAL:
3794 // May not be optimal. TODO: reconsider this warning based on other constraints.
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003795 skip |= LogPerformanceWarning(
3796 device, kVUID_Core_DrawState_InvalidImageLayout,
3797 "%s: Layout for input attachment reference %u in subpass %u is GENERAL but should be READ_ONLY_OPTIMAL.",
3798 function_name, j, i);
Cort Stratton7547f772017-05-04 15:18:52 -07003799 break;
3800
Tobias Hectorbbb12282018-10-22 15:17:59 +01003801 case VK_IMAGE_LAYOUT_UNDEFINED:
3802 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003803 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003804 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003805 "%s: Layout for input attachment reference %u in subpass %u is %s but must be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003806 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003807 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003808 break;
3809
Piers Daniell9af77cd2019-10-16 13:54:12 -06003810 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3811 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3812 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3813 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003814 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003815 skip |= LogError(
3816 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003817 "%s: Layout for input attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06003818 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3819 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003820 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06003821 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003822 skip |= LogError(
3823 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003824 "%s: Layout for input attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06003825 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3826 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003827 function_name, j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06003828 } else if ((subpass.pInputAttachments[j].aspectMask &
3829 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3830 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3831 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3832 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3833 const auto *attachment_reference_stencil_layout =
3834 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3835 if (attachment_reference_stencil_layout) {
3836 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3837 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3838 attachment_reference_stencil_layout->stencilLayout ==
3839 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3840 attachment_reference_stencil_layout->stencilLayout ==
3841 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3842 attachment_reference_stencil_layout->stencilLayout ==
3843 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3844 attachment_reference_stencil_layout->stencilLayout ==
3845 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3846 attachment_reference_stencil_layout->stencilLayout ==
3847 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3848 attachment_reference_stencil_layout->stencilLayout ==
3849 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3850 attachment_reference_stencil_layout->stencilLayout ==
3851 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3852 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003853 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003854 "%s: In the attachment reference %u in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003855 "VkAttachmentReferenceStencilLayoutKHR"
3856 "the stencilLayout member but must not be "
3857 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3858 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3859 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3860 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3861 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3862 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3863 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3864 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3865 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003866 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003867 }
3868 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003869 skip |= LogError(
3870 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003871 "%s: When the layout for input attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003872 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3873 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3874 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003875 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003876 }
3877 }
3878 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3879 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3880 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003881 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03315",
3882 "%s: When the aspectMask for input attachment reference %u in subpass %u is "
3883 "VK_IMAGE_ASPECT_DEPTH_BIT "
3884 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3885 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3886 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003887 }
3888 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3889 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3890 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003891 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003892 "%s: When the aspectMask for input attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003893 "VK_IMAGE_ASPECT_STENCIL_BIT "
3894 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3895 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003896 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06003897 }
3898 }
3899 break;
3900
Graeme Leese668a9862018-10-08 10:40:02 +01003901 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3902 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003903 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003904 break;
3905 } else {
3906 // Intentionally fall through to generic error message
3907 }
3908 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003909
Cort Stratton7547f772017-05-04 15:18:52 -07003910 default:
3911 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003912 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003913 "%s: Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3914 function_name, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Cort Stratton7547f772017-05-04 15:18:52 -07003915 }
3916
Cort Stratton7547f772017-05-04 15:18:52 -07003917 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003918 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3919 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003920
3921 bool used_as_depth =
3922 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3923 bool used_as_color = false;
3924 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3925 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3926 }
3927 if (!used_as_depth && !used_as_color &&
3928 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003929 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003930 skip |= LogError(device, vuid,
3931 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
Mark Lobodzinski6ff146b2020-05-22 14:37:05 -06003932 function_name, attach_index, i);
Cort Stratton7547f772017-05-04 15:18:52 -07003933 }
3934 }
3935 attach_first_use[attach_index] = false;
3936 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003937
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003938 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3939 auto attach_index = subpass.pColorAttachments[j].attachment;
3940 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3941
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003942 // TODO: Need a way to validate shared presentable images here, currently just allowing
3943 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3944 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003945 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003946 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003947 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003948 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3949 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003950 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003951
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003952 case VK_IMAGE_LAYOUT_GENERAL:
3953 // May not be optimal; TODO: reconsider this warning based on other constraints?
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003954 skip |= LogPerformanceWarning(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003955 "%s: Layout for color attachment reference %u in subpass %u is GENERAL but "
3956 "should be COLOR_ATTACHMENT_OPTIMAL.",
3957 function_name, j, i);
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003958 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003959
Tobias Hectorbbb12282018-10-22 15:17:59 +01003960 case VK_IMAGE_LAYOUT_UNDEFINED:
3961 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003962 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003963 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003964 "%s: Layout for color attachment reference %u in subpass %u is %s but should be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003965 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003966 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003967 break;
3968
Piers Daniell9af77cd2019-10-16 13:54:12 -06003969 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3970 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3971 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3972 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003973 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003974 skip |= LogError(
3975 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003976 "%s: Layout for color attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06003977 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3978 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003979 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06003980 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003981 skip |= LogError(
3982 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003983 "%s: Layout for color attachment reference %u in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06003984 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3985 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003986 function_name, j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06003987 } else if ((subpass.pColorAttachments[j].aspectMask &
3988 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3989 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3990 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3991 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3992 const auto *attachment_reference_stencil_layout =
3993 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3994 if (attachment_reference_stencil_layout) {
3995 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3996 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3997 attachment_reference_stencil_layout->stencilLayout ==
3998 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3999 attachment_reference_stencil_layout->stencilLayout ==
4000 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4001 attachment_reference_stencil_layout->stencilLayout ==
4002 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4003 attachment_reference_stencil_layout->stencilLayout ==
4004 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4005 attachment_reference_stencil_layout->stencilLayout ==
4006 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4007 attachment_reference_stencil_layout->stencilLayout ==
4008 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4009 attachment_reference_stencil_layout->stencilLayout ==
4010 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4011 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004012 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004013 "%s: In the attachment reference %u in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004014 "VkAttachmentReferenceStencilLayoutKHR"
4015 "the stencilLayout member but must not be "
4016 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4017 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4018 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4019 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4020 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4021 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4022 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4023 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4024 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004025 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004026 }
4027 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004028 skip |= LogError(
4029 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004030 "%s: When the layout for color attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004031 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4032 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4033 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004034 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004035 }
4036 }
4037 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4038 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4039 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004040 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03315",
4041 "%s: When the aspectMask for color attachment reference %u in subpass %u is "
4042 "VK_IMAGE_ASPECT_DEPTH_BIT "
4043 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4044 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4045 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004046 }
4047 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4048 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4049 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004050 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004051 "%s: When the aspectMask for color attachment reference %u in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004052 "VK_IMAGE_ASPECT_STENCIL_BIT "
4053 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4054 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004055 function_name, j, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004056 }
4057 }
4058 break;
4059
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004060 default:
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004061 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004062 "%s: Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
4063 function_name, string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004064 }
4065
John Zulauf4eee2692019-02-09 16:14:25 -07004066 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
4067 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
4068 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08004069 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004070 skip |= LogError(device, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004071 "%s: Layout for resolve attachment reference %u in subpass %u is %s but should be "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004072 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004073 function_name, j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004074 }
4075
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004076 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004077 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
4078 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004079 }
4080 attach_first_use[attach_index] = false;
4081 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004082
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004083 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
4084 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004085 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
4086 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
4087 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06004088 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06004089
Dave Houltona9df0ce2018-02-07 10:51:23 -07004090 case VK_IMAGE_LAYOUT_GENERAL:
4091 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
4092 // doing a bunch of transitions.
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004093 skip |= LogPerformanceWarning(
4094 device, kVUID_Core_DrawState_InvalidImageLayout,
4095 "%s: GENERAL layout for depth attachment reference in subpass %u may not give optimal performance.",
4096 function_name, i);
Dave Houltona9df0ce2018-02-07 10:51:23 -07004097 break;
4098
Tobias Hectorbbb12282018-10-22 15:17:59 +01004099 case VK_IMAGE_LAYOUT_UNDEFINED:
4100 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08004101 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004102 skip |=
4103 LogError(device, vuid,
4104 "%s: Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
4105 "layout or GENERAL.",
4106 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01004107 break;
4108
Piers Daniell9af77cd2019-10-16 13:54:12 -06004109 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
4110 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
4111 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4112 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004113 if (!enabled_features.core12.separateDepthStencilLayouts) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004114 skip |= LogError(
4115 device, "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004116 "%s: Layout for depth attachment reference in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004117 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4118 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004119 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004120 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004121 skip |= LogError(
4122 device, "VUID-VkAttachmentReference2-attachment-03314",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004123 "%s: Layout for depth attachment reference in subpass %u is %s but must not be "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004124 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4125 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004126 function_name, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Piers Daniell9af77cd2019-10-16 13:54:12 -06004127 } else if ((subpass.pDepthStencilAttachment->aspectMask &
4128 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4129 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4130 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4131 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4132 const auto *attachment_reference_stencil_layout =
4133 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
4134 if (attachment_reference_stencil_layout) {
4135 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4136 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4137 attachment_reference_stencil_layout->stencilLayout ==
4138 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4139 attachment_reference_stencil_layout->stencilLayout ==
4140 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4141 attachment_reference_stencil_layout->stencilLayout ==
4142 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4143 attachment_reference_stencil_layout->stencilLayout ==
4144 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4145 attachment_reference_stencil_layout->stencilLayout ==
4146 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4147 attachment_reference_stencil_layout->stencilLayout ==
4148 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4149 attachment_reference_stencil_layout->stencilLayout ==
4150 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4151 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004152 skip |= LogError(device, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004153 "%s: In the attachment reference in subpass %u with pNext chain instance "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004154 "VkAttachmentReferenceStencilLayoutKHR"
4155 "the stencilLayout member but must not be "
4156 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4157 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4158 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4159 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4160 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4161 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4162 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4163 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4164 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004165 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004166 }
4167 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004168 skip |= LogError(
4169 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004170 "%s: When the layout for depth attachment reference in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004171 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4172 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4173 "VkAttachmentReferenceStencilLayout instance.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004174 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004175 }
4176 }
4177 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4178 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4179 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004180 skip |= LogError(
4181 device, "VUID-VkAttachmentReference2-attachment-03315",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004182 "%s: When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
Piers Daniell9af77cd2019-10-16 13:54:12 -06004183 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4184 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004185 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004186 }
4187 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4188 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4189 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004190 skip |= LogError(device, "VUID-VkAttachmentReference2-attachment-03317",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004191 "%s: When the aspectMask for depth attachment reference in subpass %u is "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004192 "VK_IMAGE_ASPECT_STENCIL_BIT "
4193 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4194 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004195 function_name, i);
Piers Daniell9af77cd2019-10-16 13:54:12 -06004196 }
4197 }
4198 break;
4199
Dave Houltona9df0ce2018-02-07 10:51:23 -07004200 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4201 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004202 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004203 break;
4204 } else {
4205 // Intentionally fall through to generic error message
4206 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004207 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004208
Dave Houltona9df0ce2018-02-07 10:51:23 -07004209 default:
4210 // No other layouts are acceptable
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004211 skip |= LogError(device, kVUID_Core_DrawState_InvalidImageLayout,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004212 "%s: Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004213 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004214 function_name, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004215 }
4216
4217 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4218 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004219 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4220 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004221 }
4222 attach_first_use[attach_index] = false;
4223 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004224 }
4225 return skip;
4226}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004227
Mark Lobodzinski96210742017-02-09 10:33:46 -07004228// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4229// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004230template <typename T1>
4231bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4232 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4233 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004234 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004235 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004236 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004237 if (strict) {
4238 correct_usage = ((actual & desired) == desired);
4239 } else {
4240 correct_usage = ((actual & desired) != 0);
4241 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004242
Mark Lobodzinski96210742017-02-09 10:33:46 -07004243 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004244 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004245 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004246 skip = LogError(object, kVUID_Core_MemTrack_InvalidUsageFlag,
4247 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4248 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004249 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004250 skip = LogError(object, msgCode,
4251 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4252 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004253 }
4254 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004255 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004256}
4257
4258// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4259// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004260bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004261 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004262 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004263 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004264}
4265
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004266bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004267 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004268 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004269 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4270 if ((image_format_features & desired) != desired) {
4271 // Same error, but more details if it was an AHB external format
4272 if (image_state->has_ahb_format == true) {
4273 skip |= LogError(image_state->image, vuid,
4274 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4275 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4276 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004277 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004278 } else {
4279 skip |= LogError(image_state->image, vuid,
4280 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4281 "with tiling %s.",
4282 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4283 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4284 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004285 }
4286 }
4287 return skip;
4288}
4289
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004290bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004291 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004292 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004293 // layerCount must not be zero
4294 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004295 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4296 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004297 }
4298 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4299 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004300 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4301 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004302 }
4303 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4304 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4305 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004306 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4307 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4308 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4309 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004310 }
4311 return skip;
4312}
4313
Mark Lobodzinski96210742017-02-09 10:33:46 -07004314// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4315// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004316bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004317 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004318 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004319 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004320}
4321
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004322bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004323 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004324 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004325
4326 const VkDeviceSize &range = pCreateInfo->range;
4327 if (range != VK_WHOLE_SIZE) {
4328 // Range must be greater than 0
4329 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004330 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004331 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004332 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4333 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004334 }
4335 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004336 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4337 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004338 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004339 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004340 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4341 "(%" PRIu32 ").",
4342 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004343 }
4344 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004345 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004346 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004347 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004348 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4349 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4350 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004351 }
4352 // The sum of range and offset must be less than or equal to the size of buffer
4353 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004354 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004355 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004356 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4357 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4358 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004359 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004360 } else {
4361 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4362
4363 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4364 // VkPhysicalDeviceLimits::maxTexelBufferElements
4365 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4366 device_limits->maxTexelBufferElements) {
4367 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4368 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4369 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4370 "), divided by the element size of the format (%" PRIu32
4371 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4372 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4373 device_limits->maxTexelBufferElements);
4374 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004375 }
4376 return skip;
4377}
4378
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004379bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004380 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004381 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004382 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4383 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004384 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004385 "vkCreateBufferView(): If buffer was created with `usage` containing "
4386 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004387 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004388 }
4389 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4390 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004391 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004392 "vkCreateBufferView(): If buffer was created with `usage` containing "
4393 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004394 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004395 }
4396 return skip;
4397}
4398
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004399bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004400 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004401 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004402
Dave Houltond8ed0212018-05-16 17:18:24 -06004403 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004404
Jeff Bolz87697532019-01-11 22:54:00 -06004405 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4406 if (chained_devaddr_struct) {
4407 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4408 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004409 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4410 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4411 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004412 }
4413 }
4414
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004415 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4416 if (chained_opaqueaddr_struct) {
4417 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4418 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004419 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4420 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4421 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004422 }
4423 }
4424
Shannon McPherson4984e642019-12-05 13:04:34 -07004425 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004426 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4427 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004428 skip |= LogError(
4429 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004430 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4431 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4432 }
4433
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004434 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004435 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4436 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4437 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004438 }
4439
sfricke-samsungedce77a2020-07-03 22:35:13 -07004440 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4441 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4442 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4443 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4444 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4445 }
4446 const VkBufferCreateFlags invalid_flags =
4447 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4448 if ((pCreateInfo->flags & invalid_flags) != 0) {
4449 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4450 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4451 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4452 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4453 }
4454 }
4455
Mark Lobodzinski96210742017-02-09 10:33:46 -07004456 return skip;
4457}
4458
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004459bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004460 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004461 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004462 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004463 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4464 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004465 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004466 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4467 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004468 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004469 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4470 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4471 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004472
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004473 // Buffer view offset must be less than the size of buffer
4474 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004475 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004476 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004477 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4478 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004479 }
4480
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004481 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004482 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4483 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4484 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004485 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4486 : "VUID-VkBufferViewCreateInfo-offset-00926";
4487 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004488 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004489 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4490 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004491 }
4492
4493 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4494 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4495 if ((elementSize % 3) == 0) {
4496 elementSize /= 3;
4497 }
4498 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4499 VkDeviceSize alignmentRequirement =
4500 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4501 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4502 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4503 }
4504 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004505 skip |= LogError(
4506 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004507 "vkCreateBufferView(): If buffer was created with usage containing "
4508 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004509 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4510 ") must be a multiple of the lesser of "
4511 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4512 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4513 "(%" PRId32
4514 ") is VK_TRUE, the size of a texel of the requested format. "
4515 "If the size of a texel is a multiple of three bytes, then the size of a "
4516 "single component of format is used instead",
4517 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4518 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4519 }
4520 }
4521 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4522 VkDeviceSize alignmentRequirement =
4523 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4524 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4525 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4526 }
4527 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004528 skip |= LogError(
4529 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004530 "vkCreateBufferView(): If buffer was created with usage containing "
4531 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004532 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4533 ") must be a multiple of the lesser of "
4534 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4535 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4536 "(%" PRId32
4537 ") is VK_TRUE, the size of a texel of the requested format. "
4538 "If the size of a texel is a multiple of three bytes, then the size of a "
4539 "single component of format is used instead",
4540 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4541 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4542 }
4543 }
4544 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004545
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004546 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004547
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004548 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004549 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004550 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004551}
4552
Mark Lobodzinski602de982017-02-09 11:01:33 -07004553// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004554bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004555 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004556 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004557 const IMAGE_STATE *image_state = GetImageState(image);
4558 // checks color format and (single-plane or non-disjoint)
4559 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004560 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004561 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004562 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 -07004563 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004564 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 -07004565 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004566 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004567 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004568 skip |= LogError(image, vuid,
4569 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4570 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4571 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004572 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004573 skip |= LogError(image, vuid,
4574 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4575 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4576 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004577 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004578 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004579 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004580 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 -07004581 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004582 skip |=
4583 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 -07004584 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004585 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004586 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004587 skip |=
4588 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 -07004589 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004590 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4591 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004592 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004593 } else if (FormatIsMultiplane(format)) {
4594 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4595 if (3 == FormatPlaneCount(format)) {
4596 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4597 }
4598 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004599 skip |=
4600 LogError(image, vuid,
4601 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4602 "set, where n = [0, 1, 2].",
4603 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004604 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004605 }
4606 return skip;
4607}
4608
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004609bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4610 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004611 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4612 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004613 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004614
4615 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004616 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004617 skip |= LogError(image, errorCodes.base_mip_err,
4618 "%s: %s.baseMipLevel (= %" PRIu32
4619 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4620 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004621 }
Petr Kraus4d718682017-05-18 03:38:41 +02004622
Petr Krausffa94af2017-08-08 21:46:02 +02004623 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4624 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004625 skip |=
4626 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004627 } else {
4628 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004629
Petr Krausffa94af2017-08-08 21:46:02 +02004630 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004631 skip |= LogError(image, errorCodes.mip_count_err,
4632 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4633 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4634 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4635 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004636 }
Petr Kraus4d718682017-05-18 03:38:41 +02004637 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004638 }
Petr Kraus4d718682017-05-18 03:38:41 +02004639
4640 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004641 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004642 skip |= LogError(image, errorCodes.base_layer_err,
4643 "%s: %s.baseArrayLayer (= %" PRIu32
4644 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4645 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004646 }
Petr Kraus4d718682017-05-18 03:38:41 +02004647
Petr Krausffa94af2017-08-08 21:46:02 +02004648 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4649 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004650 skip |=
4651 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004652 } else {
4653 const uint64_t necessary_layer_count =
4654 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004655
Petr Krausffa94af2017-08-08 21:46:02 +02004656 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004657 skip |= LogError(image, errorCodes.layer_count_err,
4658 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4659 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4660 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4661 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004662 }
Petr Kraus4d718682017-05-18 03:38:41 +02004663 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004664 }
Petr Kraus4d718682017-05-18 03:38:41 +02004665
Mark Lobodzinski602de982017-02-09 11:01:33 -07004666 return skip;
4667}
4668
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004669bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004670 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004671 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004672 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4673 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4674 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4675
4676 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4677 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4678
4679 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004680 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4681 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004682 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004683 : "VUID-VkImageViewCreateInfo-image-01482")
4684 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4685 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004686 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004687 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4688 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004689
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004690 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004691 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004692 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004693}
4694
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004695bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004696 const VkImageSubresourceRange &subresourceRange,
4697 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004698 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004699 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4700 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4701 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4702 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004703
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004704 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004705 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004706 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004707}
4708
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004709bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004710 const VkImageSubresourceRange &subresourceRange,
4711 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004712 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004713 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4714 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4715 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4716 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004717
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004718 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004719 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4720 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004721}
4722
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004723bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004724 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004725 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004726 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004727 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4728 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4729 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4730 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004731
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004732 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004733 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004734}
4735
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004736bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4737 const VkImageUsageFlags image_usage) const {
4738 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4739 bool skip = false;
4740
4741 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4742 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4743
4744 if (image_state->has_ahb_format == true) {
4745 // AHB image view and image share same feature sets
4746 tiling_features = image_state->format_features;
4747 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4748 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4749 assert(device_extensions.vk_ext_image_drm_format_modifier);
4750 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4751 nullptr};
4752 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4753
4754 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4755 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4756 nullptr};
4757 format_properties_2.pNext = (void *)&drm_properties_list;
4758 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4759
4760 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4761 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4762 0) {
4763 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4764 }
4765 }
4766 } else {
4767 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4768 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4769 : format_properties.optimalTilingFeatures;
4770 }
4771
4772 if (tiling_features == 0) {
4773 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4774 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4775 "physical device.",
4776 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4777 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4778 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4779 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4780 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4781 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4782 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4783 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4784 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4785 "VK_IMAGE_USAGE_STORAGE_BIT.",
4786 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4787 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4788 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4789 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4790 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4791 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4792 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4793 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4794 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4795 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4796 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4797 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4798 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4799 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4800 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4801 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4802 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4803 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4804 }
4805
4806 return skip;
4807}
4808
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004809bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004810 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004811 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004812 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004813 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004814 skip |=
4815 ValidateImageUsageFlags(image_state,
4816 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4817 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4818 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4819 false, kVUIDUndefined, "vkCreateImageView()",
4820 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4821 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004822 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004823 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004824 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004825 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004826 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004827 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004828
4829 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4830 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004831 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004832 VkFormat view_format = pCreateInfo->format;
4833 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004834 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004835 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004836
Dave Houltonbd2e2622018-04-10 16:41:14 -06004837 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004838 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004839 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004840 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004841 if (!device_extensions.vk_ext_separate_stencil_usage) {
4842 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004843 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4844 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4845 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004846 }
4847 } else {
4848 const auto image_stencil_struct =
4849 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4850 if (image_stencil_struct == nullptr) {
4851 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004852 skip |= LogError(
4853 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004854 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4855 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4856 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4857 }
4858 } else {
4859 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4860 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4861 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004862 skip |= LogError(
4863 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004864 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4865 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4866 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4867 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4868 }
4869 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4870 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004871 skip |= LogError(
4872 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004873 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4874 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4875 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4876 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4877 }
4878 }
4879 }
4880 }
4881
Dave Houltonbd2e2622018-04-10 16:41:14 -06004882 image_usage = chained_ivuci_struct->usage;
4883 }
4884
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004885 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4886 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004887 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004888 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004889 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004890 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004891 std::stringstream ss;
4892 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004893 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004894 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004895 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004896 }
4897 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004898 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06004899 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4900 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004901 const char *error_vuid;
4902 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4903 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4904 } else if ((device_extensions.vk_khr_maintenance2) &&
4905 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4906 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4907 } else if ((!device_extensions.vk_khr_maintenance2) &&
4908 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4909 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4910 } else {
4911 // both enabled
4912 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4913 }
Dave Houltonc7988072018-04-16 11:46:56 -06004914 std::stringstream ss;
4915 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004916 << " is not in the same format compatibility class as "
4917 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004918 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4919 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004920 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004921 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004922 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004923 }
4924 } else {
4925 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004926 // Unless it is a multi-planar color bit aspect
4927 if ((image_format != view_format) &&
4928 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4929 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4930 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004931 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004932 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004933 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004934 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004935 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004936 }
4937 }
4938
4939 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004940 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004941
4942 switch (image_type) {
4943 case VK_IMAGE_TYPE_1D:
4944 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004945 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4946 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4947 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004948 }
4949 break;
4950 case VK_IMAGE_TYPE_2D:
4951 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4952 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4953 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004954 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4955 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4956 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004957 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004958 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4959 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4960 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004961 }
4962 }
4963 break;
4964 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004965 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004966 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4967 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4968 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004969 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004970 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4971 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4972 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004973 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4974 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004975 skip |= LogError(
4976 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4977 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4978 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4979 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4980 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004981 }
4982 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004983 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4984 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4985 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004986 }
4987 }
4988 } else {
4989 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004990 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4991 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4992 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004993 }
4994 }
4995 break;
4996 default:
4997 break;
4998 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004999
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005000 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005001 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005002 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005003 }
5004
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005005 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005006
Jeff Bolz9af91c52018-09-01 21:53:57 -05005007 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5008 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005009 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5010 "vkCreateImageView() If image was created with usage containing "
5011 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
5012 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005013 }
5014 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005015 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5016 "vkCreateImageView() If image was created with usage containing "
5017 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005018 }
5019 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005020
5021 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5022 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5023 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5024 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5025 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5026 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5027 }
5028 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5029 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5030 skip |= LogError(
5031 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5032 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5033 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5034 }
5035 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005036
5037 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5038 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005039 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005040 "vkCreateImageView(): If image was created with usage containing "
5041 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5042 pCreateInfo->subresourceRange.levelCount);
5043 }
5044 }
5045 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5046 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005047 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005048 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5049 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5050 }
5051 } else {
5052 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5053 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5054 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005055 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005056 "vkCreateImageView(): If image was created with usage containing "
5057 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5058 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5059 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5060 }
5061 }
5062 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005063
5064 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
5065 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5066 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5067 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5068 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5069 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5070 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5071 }
5072 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005073 }
5074 return skip;
5075}
5076
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005077bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
5078 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005079 bool skip = false;
5080
5081 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5082 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5083 VkDeviceSize src_min = UINT64_MAX;
5084 VkDeviceSize src_max = 0;
5085 VkDeviceSize dst_min = UINT64_MAX;
5086 VkDeviceSize dst_max = 0;
5087
5088 for (uint32_t i = 0; i < regionCount; i++) {
5089 src_min = std::min(src_min, pRegions[i].srcOffset);
5090 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5091 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5092 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5093
5094 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5095 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005096 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
5097 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
5098 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5099 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005100 }
5101
5102 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5103 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005104 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
5105 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
5106 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5107 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005108 }
5109
5110 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5111 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005112 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
5113 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5114 ") is greater than the source buffer size (%" PRIuLEAST64
5115 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
5116 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005117 }
5118
5119 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5120 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005121 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
5122 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
5123 ") is greater than the destination buffer size (%" PRIuLEAST64
5124 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
5125 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005126 }
5127 }
5128
5129 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5130 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5131 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005132 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
5133 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005134 }
5135 }
5136
5137 return skip;
5138}
5139
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005140bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005141 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005142 const auto cb_node = GetCBState(commandBuffer);
5143 const auto src_buffer_state = GetBufferState(srcBuffer);
5144 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005145
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005146 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005147 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5148 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005149 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005150 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005151 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5152 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005153 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005154 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5155 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005156 skip |=
5157 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5158 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005159 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5160 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005161 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005162 return skip;
5163}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005164
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005165bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005166 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005167 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005168 if (!buffer_state) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005169 skip |= LogError(buffer, kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
5170 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005171 } else {
5172 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005173 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5174 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005175 }
5176 }
5177 return skip;
5178}
5179
Jeff Bolz5c801d12019-10-09 10:38:45 -05005180bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5181 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005182 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005183 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005184
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005185 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005186 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005187 skip |=
5188 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005189 }
5190 return skip;
5191}
5192
Jeff Bolz5c801d12019-10-09 10:38:45 -05005193bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005194 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005195
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005196 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005197 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005198 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005199 }
5200 return skip;
5201}
5202
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005203bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005204 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005205 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005206 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005207 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005208 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005209 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005210 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005211 }
5212 return skip;
5213}
5214
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005215bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005216 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005217 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005218 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005219 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005220 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005221 skip |=
5222 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5223 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005224 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005225 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005226 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5227 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005228 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005229
5230 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005231 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5232 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5233 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5234 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005235 }
5236
5237 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005238 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5239 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5240 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5241 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005242 }
5243
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005244 return skip;
5245}
5246
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005247bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
5248 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005249 bool skip = false;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005250 assert(image_state != nullptr);
5251 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005252
5253 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005254 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005255 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5256 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005257 skip |=
5258 LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00199",
5259 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5260 "and 1, respectively.",
5261 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005262 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005263 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005264
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005265 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5266 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005267 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-srcImage-00201",
5268 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
5269 "must be 0 and 1, respectively.",
5270 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005271 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005272 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005273
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005274 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5275 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005276 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-baseArrayLayer-00213",
5277 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5278 "For 3D images these must be 0 and 1, respectively.",
5279 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005280 }
5281 }
5282
5283 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005284 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005285 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005286
sfricke-samsung125d2b42020-05-28 06:32:43 -07005287 // If not depth/stencil and not multi-plane
5288 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5289 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
5290 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-bufferOffset-01558"
5291 : "VUID-VkBufferImageCopy-bufferOffset-00193";
5292 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005293 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5294 " must be a multiple of this format's texel size (%" PRIu32 ").",
5295 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005296 }
5297
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005298 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5299 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005300 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005301 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
5302 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5303 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005304 }
5305
5306 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5307 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005308 skip |= LogError(
5309 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005310 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5311 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005312 }
5313
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005314 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005315 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005316 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005317 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 -06005318 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5319 static_cast<int32_t>(adjusted_image_extent.width))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005320 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00197",
5321 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5322 "zero or <= image subresource width (%d).",
5323 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005324 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005325 }
5326
5327 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005328 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 -06005329 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5330 static_cast<int32_t>(adjusted_image_extent.height))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005331 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00198",
5332 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5333 "zero or <= image subresource height (%d).",
5334 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005335 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005336 }
5337
5338 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005339 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 -06005340 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5341 static_cast<int32_t>(adjusted_image_extent.depth))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005342 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-imageOffset-00200",
5343 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5344 "zero or <= image subresource depth (%d).",
5345 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005346 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005347 }
5348
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005349 // subresource aspectMask must have exactly 1 bit set
5350 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005351 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005352 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005353 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005354 "%s(): aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005355 }
5356
5357 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005358 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005359 skip |= LogError(
5360 image_state->image, "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005361 "%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 -07005362 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005363 }
5364
5365 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005366 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5367 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005368
5369 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005370 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005371 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5372 ? "VUID-VkBufferImageCopy-None-01735"
5373 : "VUID-VkBufferImageCopy-bufferRowLength-00203";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005374 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005375 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005376 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5377 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005378 }
5379
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005380 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005381 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005382 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5383 ? "VUID-VkBufferImageCopy-None-01736"
5384 : "VUID-VkBufferImageCopy-bufferImageHeight-00204";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005385 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005386 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005387 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5388 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005389 }
5390
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005391 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005392 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5393 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5394 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005395 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01737"
5396 : "VUID-VkBufferImageCopy-imageOffset-00205";
5397 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005398 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5399 "width & height (%d, %d)..",
5400 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5401 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005402 }
5403
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005404 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005405 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005406 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005407 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5408 ? "VUID-VkBufferImageCopy-None-01738"
5409 : "VUID-VkBufferImageCopy-bufferOffset-00206";
5410 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005411 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5412 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5413 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005414 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005415
5416 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005417 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005418 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005419 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005420 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01739"
5421 : "VUID-VkBufferImageCopy-imageExtent-00207";
5422 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005423 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5424 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5425 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5426 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005427 }
5428
5429 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005430 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005431 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005432 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01740"
5433 : "VUID-VkBufferImageCopy-imageExtent-00208";
5434 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005435 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5436 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5437 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5438 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005439 }
5440
5441 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005442 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005443 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005444 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkBufferImageCopy-None-01741"
5445 : "VUID-VkBufferImageCopy-imageExtent-00209";
5446 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005447 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5448 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5449 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5450 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005451 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005452 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005453
5454 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005455 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005456 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005457 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005458 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5459 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5460 "format has three planes.",
5461 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005462 }
5463
5464 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005465 if (0 ==
5466 (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 -07005467 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-01560",
5468 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5469 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5470 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005471 } else {
5472 // Know aspect mask is valid
5473 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5474 const uint32_t compatible_size = FormatElementSize(compatible_format);
5475 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5476 skip |= LogError(
5477 image_state->image, "VUID-VkBufferImageCopy-bufferOffset-01559",
5478 "%s(): pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
5479 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5480 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5481 string_VkFormat(compatible_format));
5482 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005483 }
5484 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005485 }
5486
5487 return skip;
5488}
5489
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005490bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5491 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005492 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005493 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005494
5495 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005496 VkExtent3D extent = pRegions[i].imageExtent;
5497 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005498
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005499 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5500 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005501 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5502 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5503 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005504 }
5505
5506 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5507
5508 // 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 -06005509 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005510 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005511 if (image_extent.width % block_extent.width) {
5512 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5513 }
5514 if (image_extent.height % block_extent.height) {
5515 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5516 }
5517 if (image_extent.depth % block_extent.depth) {
5518 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5519 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005520 }
5521
Dave Houltonfc1a4052017-04-27 14:32:45 -06005522 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005523 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005524 }
5525 }
5526
5527 return skip;
5528}
5529
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005530bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5531 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005532 bool skip = false;
5533
5534 VkDeviceSize buffer_size = buff_state->createInfo.size;
5535
5536 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005537 VkDeviceSize max_buffer_offset =
5538 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5539 if (buffer_size < max_buffer_offset) {
5540 skip |=
5541 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 -07005542 }
5543 }
5544
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005545 return skip;
5546}
5547
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005548bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005549 VkBuffer dstBuffer, uint32_t regionCount,
5550 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005551 const auto cb_node = GetCBState(commandBuffer);
5552 const auto src_image_state = GetImageState(srcImage);
5553 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005554
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005555 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005556
5557 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005558 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005559
5560 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005561 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005562
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005563 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005564
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005565 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005566 skip |=
5567 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5568 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5569 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005570 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005571 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005572 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005573 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005574 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005575
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005576 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005577 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005578 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5579 skip |=
5580 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005581
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005582 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005583 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005584 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5585 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005586 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005587 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5588 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005589
5590 // Validation for VK_EXT_fragment_density_map
5591 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5592 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyImageToBuffer-srcImage-02544",
5593 "vkCmdCopyBufferToImage(): srcImage must not have been created with flags containing "
5594 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5595 }
5596
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005597 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005598 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005599 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005600 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005601 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005602 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005603 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5604 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5605 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005606 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005607 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005608 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005609 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005610 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5611 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005612 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5613 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5614 skip |=
5615 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5616 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5617 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005618 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5619 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005620 }
5621 return skip;
5622}
5623
John Zulauf1686f232019-07-09 16:27:11 -06005624void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5625 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5626 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5627
5628 auto cb_node = GetCBState(commandBuffer);
5629 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005630 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005631 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005632 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005633 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005634}
5635
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005636bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5637 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005638 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005639 const auto cb_node = GetCBState(commandBuffer);
5640 const auto src_buffer_state = GetBufferState(srcBuffer);
5641 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005642
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005643 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005644
5645 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005646 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005647
5648 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005649 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005650 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005651 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005652 skip |=
5653 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5654 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5655 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005656 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005657 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005658 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005659 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005660 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005661 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005662 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005663 skip |=
5664 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5665 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005666 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005667 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5668 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005669 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005670 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5671 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005672
5673 // Validation for VK_EXT_fragment_density_map
5674 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5675 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyBufferToImage-dstImage-02543",
5676 "vkCmdCopyBufferToImage(): dstImage must not have been created with flags containing "
5677 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5678 }
5679
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005680 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005681 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005682 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005683 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005684 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005685 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005686 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5687 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5688 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005689 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005690 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005691 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005692 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005693 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5694 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005695 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5696 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5697 skip |=
5698 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5699 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5700 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005701 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5702 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005703 }
5704 return skip;
5705}
5706
John Zulauf1686f232019-07-09 16:27:11 -06005707void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5708 VkImageLayout dstImageLayout, uint32_t regionCount,
5709 const VkBufferImageCopy *pRegions) {
5710 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5711
5712 auto cb_node = GetCBState(commandBuffer);
5713 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005714 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005715 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005716 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005717 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005718}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005719
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005720bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005721 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005722 bool skip = false;
5723 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5724
Dave Houlton1d960ff2018-01-19 12:17:05 -07005725 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005726 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5727 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5728 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005729 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5730 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005731 }
5732
John Zulaufa26d3c82019-08-14 16:09:08 -06005733 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005734 if (!image_entry) {
5735 return skip;
5736 }
5737
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005738 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5739 if (device_extensions.vk_ext_image_drm_format_modifier) {
5740 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5741 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005742 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5743 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5744 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005745 }
5746 } else {
5747 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005748 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5749 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005750 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005751 }
5752
Dave Houlton1d960ff2018-01-19 12:17:05 -07005753 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005754 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005755 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5756 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5757 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005758 }
5759
Dave Houlton1d960ff2018-01-19 12:17:05 -07005760 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005761 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005762 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5763 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5764 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005765 }
5766
Dave Houlton1d960ff2018-01-19 12:17:05 -07005767 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005768 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005769 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5770 if (FormatIsMultiplane(img_format)) {
5771 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5772 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5773 if (FormatPlaneCount(img_format) > 2u) {
5774 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5775 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5776 }
5777 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005778 skip |= LogError(image, vuid,
5779 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5780 ") must be a single-plane specifier flag.",
5781 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005782 }
5783 } else if (FormatIsColor(img_format)) {
5784 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005785 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5786 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5787 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005788 }
5789 } else if (FormatIsDepthOrStencil(img_format)) {
5790 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5791 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005792 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005793 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5794 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5795 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5796 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005797 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5798 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5799 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005800 }
5801 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005802
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005803 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005804 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005805 }
5806
Mike Weiblen672b58b2017-02-21 14:32:53 -07005807 return skip;
5808}