blob: 31d29bbb0e2a17e02216cd3dbd8e3d34fbbc7b72 [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};
Benjamin Thautd0bc2a92020-08-25 17:09:09 +020055
56#ifdef VK_USE_PLATFORM_ANDROID_KHR
57 const VkExternalFormatANDROID *pExternalFormatANDROID = lvl_find_in_chain<VkExternalFormatANDROID>(&create_info);
58 bool isExternalFormatConversion = (pExternalFormatANDROID != nullptr && pExternalFormatANDROID->externalFormat != 0);
59#else
60 bool isExternalFormatConversion = false;
61#endif
62
63 if (FormatIsColor(format) || FormatIsMultiplane(format) || isExternalFormatConversion) {
John Zulaufb58415b2019-12-09 15:02:32 -070064 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
65 } else {
66 init_range.aspectMask =
67 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
68 }
69 return NormalizeSubresourceRange(create_info, init_range);
70}
71
locke-lunargcac25742020-08-25 16:15:40 -060072std::vector<VkImageView> FRAMEBUFFER_STATE::GetUsedAttachments(
73 const safe_VkSubpassDescription2 &subpasses, const std::vector<IMAGE_VIEW_STATE *> &imagelessFramebufferAttachments) {
locke-lunarg540b2252020-08-03 13:23:36 -060074 std::vector<VkImageView> attachment_views(createInfo.attachmentCount, VK_NULL_HANDLE);
75
locke-lunargcac25742020-08-25 16:15:40 -060076 const bool imageless = (createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) ? true : false;
77
locke-lunarg540b2252020-08-03 13:23:36 -060078 for (uint32_t index = 0; index < subpasses.inputAttachmentCount; ++index) {
locke-lunargcac25742020-08-25 16:15:40 -060079 const uint32_t attachment_index = subpasses.pInputAttachments[index].attachment;
80 if (attachment_index != VK_ATTACHMENT_UNUSED) {
81 if (imageless) {
82 attachment_views[attachment_index] = imagelessFramebufferAttachments[attachment_index]->image_view;
83 } else {
84 attachment_views[attachment_index] = createInfo.pAttachments[attachment_index];
85 }
locke-lunarg540b2252020-08-03 13:23:36 -060086 }
87 }
88 for (uint32_t index = 0; index < subpasses.colorAttachmentCount; ++index) {
locke-lunargcac25742020-08-25 16:15:40 -060089 const uint32_t attachment_index = subpasses.pColorAttachments[index].attachment;
90 if (attachment_index != VK_ATTACHMENT_UNUSED) {
91 if (imageless) {
92 attachment_views[attachment_index] = imagelessFramebufferAttachments[attachment_index]->image_view;
93 } else {
94 attachment_views[attachment_index] = createInfo.pAttachments[attachment_index];
95 }
locke-lunarg540b2252020-08-03 13:23:36 -060096 }
locke-lunargcac25742020-08-25 16:15:40 -060097 if (subpasses.pResolveAttachments) {
98 const uint32_t attachment_index2 = subpasses.pResolveAttachments[index].attachment;
99 if (attachment_index2 != VK_ATTACHMENT_UNUSED) {
100 if (imageless) {
101 attachment_views[attachment_index2] = imagelessFramebufferAttachments[attachment_index2]->image_view;
102 } else {
103 attachment_views[attachment_index2] = createInfo.pAttachments[attachment_index2];
104 }
105 }
locke-lunarg540b2252020-08-03 13:23:36 -0600106 }
107 }
locke-lunargcac25742020-08-25 16:15:40 -0600108 if (subpasses.pDepthStencilAttachment) {
109 const uint32_t attachment_index = subpasses.pDepthStencilAttachment->attachment;
110 if (attachment_index != VK_ATTACHMENT_UNUSED) {
111 if (imageless) {
112 attachment_views[attachment_index] = imagelessFramebufferAttachments[attachment_index]->image_view;
113 } else {
114 attachment_views[attachment_index] = createInfo.pAttachments[attachment_index];
115 }
116 }
locke-lunarg540b2252020-08-03 13:23:36 -0600117 }
118 return attachment_views;
119}
120
locke-lunarg296a3c92020-03-25 01:04:29 -0600121IMAGE_STATE::IMAGE_STATE(VkDevice dev, VkImage img, const VkImageCreateInfo *pCreateInfo)
John Zulauff660ad62019-03-23 07:16:05 -0600122 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -0700123 safe_create_info(pCreateInfo),
124 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -0600125 valid(false),
126 acquired(false),
127 shared_presentable(false),
128 layout_locked(false),
129 get_sparse_reqs_called(false),
130 sparse_metadata_required(false),
131 sparse_metadata_bound(false),
John Zulauff660ad62019-03-23 07:16:05 -0600132 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700133 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -0600134 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700135 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -0600136 create_from_swapchain(VK_NULL_HANDLE),
137 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -0600138 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700139 range_encoder(full_range),
sfricke-samsung71bc6572020-04-29 15:49:43 -0700140 disjoint(false),
141 plane0_memory_requirements_checked(false),
142 plane1_memory_requirements_checked(false),
143 plane2_memory_requirements_checked(false),
locke-lunarg296a3c92020-03-25 01:04:29 -0600144 subresource_encoder(full_range),
locke-lunargae26eac2020-04-16 15:29:05 -0600145 fragment_encoder(nullptr),
locke-lunarg296a3c92020-03-25 01:04:29 -0600146 store_device_as_workaround(dev), // TODO REMOVE WHEN encoder can be const
unknown08c57af2019-06-21 16:33:35 -0600147 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -0600148 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
149 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
150 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
151 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
152 }
153 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
154 }
155
156 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
157 sparse = true;
158 }
Locked8af3732019-05-10 09:47:56 -0600159
sfricke-samsunge2441192019-11-06 14:07:57 -0800160 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
161 if (externalMemoryInfo) {
162 external_memory_handle = externalMemoryInfo->handleTypes;
163 }
John Zulauff660ad62019-03-23 07:16:05 -0600164}
165
unknown2c877272019-07-11 12:56:50 -0600166bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
167 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
168 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
169 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
170 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
171 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
172 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600173 return is_equal &&
174 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600175}
176
Jeff Bolz82f854d2019-09-17 14:56:47 -0500177// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
178bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
179 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
180 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
181 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
182 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
183 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600184 is_compatible = is_compatible &&
185 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
186 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500187
188 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
189 createInfo.extent.height <= other_createInfo.extent.height &&
190 createInfo.extent.depth <= other_createInfo.extent.depth &&
191 createInfo.arrayLayers <= other_createInfo.arrayLayers;
192 return is_compatible;
193}
194
unknown2c877272019-07-11 12:56:50 -0600195bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700196 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
197 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
198 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700199 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
200 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600201 IsCreateInfoEqual(other_image_state->createInfo)) {
202 return true;
203 }
unknowne1661522019-07-11 13:04:18 -0600204 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
205 return true;
206 }
unknown2c877272019-07-11 12:56:50 -0600207 return false;
208}
209
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500210IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
211 : image_view(iv),
212 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700213 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
locke-lunarg296a3c92020-03-25 01:04:29 -0600214 range_generator(im->subresource_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500215 samplerConversion(VK_NULL_HANDLE),
216 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600217 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
218 if (conversionInfo) samplerConversion = conversionInfo->conversion;
219 if (image_state) {
220 // A light normalization of the createInfo range
221 auto &sub_res_range = create_info.subresourceRange;
222 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
223 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
224
225 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700226 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500227 samples = image_state->createInfo.samples;
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200228
229 if (image_state->has_ahb_format) {
230 // When the image has a external format the views format must be VK_FORMAT_UNDEFINED and it is required to use a sampler
231 // Ycbcr conversion. Thus we can't extract any meaningful information from the format parameter. As a Sampler Ycbcr
232 // conversion must be used the shader type is always float.
233 descriptor_format_bits = DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
234 } else {
235 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
236 }
John Zulauff660ad62019-03-23 07:16:05 -0600237 }
238}
239
locke-lunarg540b2252020-08-03 13:23:36 -0600240bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
locke-lunarg540b2252020-08-03 13:23:36 -0600241 if (image_view == compare_view.image_view) {
242 return true;
243 }
locke-lunargdc287022020-08-21 12:03:57 -0600244 if (image_state->image != compare_view.image_state->image) {
245 return false;
246 }
locke-lunarg540b2252020-08-03 13:23:36 -0600247 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
248 return false;
249 }
250
251 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600252 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600253 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600254 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600255 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600256 }
257
258 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600259 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600260 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600261 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600262 }
263
264 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600265 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600266 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600267 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600268 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600269 }
270
271 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600272 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600273 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600274 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600275 }
locke-lunargdc287022020-08-21 12:03:57 -0600276 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600277}
278
Dave Houltond9611312018-11-19 17:03:36 -0700279uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
280 // uint cast applies floor()
281 return 1u + (uint32_t)log2(std::max({height, width, depth}));
282}
283
284uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
285
286uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
287
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500288bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700289 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700290 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700291
John Zulauf2076e812020-01-08 14:55:54 -0700292 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
293 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700294 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
295 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
296
John Zulauf2076e812020-01-08 14:55:54 -0700297 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
298
299 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
300 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700301 return false;
302 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700303
John Zulauf2076e812020-01-08 14:55:54 -0700304 for (auto entry : *layout_range_map) {
305 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700306 }
307 return true;
308}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700309
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600310// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600311void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600312 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
313 VkImageLayout expected_layout) {
314 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
315 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600316 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600317 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700318 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700319 for (const auto &image : image_state.aliasing_images) {
320 auto alias_state = GetImageState(image);
321 // The map state of the aliases should all be in sync, so no need to check the return value
322 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
323 assert(subresource_map);
324 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
325 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700326}
John Zulauff660ad62019-03-23 07:16:05 -0600327
328// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600329void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600330 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500331 return;
332 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500333 IMAGE_STATE *image_state = view_state.image_state.get();
334 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700335 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700336 for (const auto &image : image_state->aliasing_images) {
337 image_state = GetImageState(image);
338 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
339 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
340 }
John Zulauff660ad62019-03-23 07:16:05 -0600341}
342
343// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600344void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600345 const VkImageSubresourceRange &range, VkImageLayout layout) {
346 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
347 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600348 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700349 for (const auto &image : image_state.aliasing_images) {
350 auto alias_state = GetImageState(image);
351 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
352 assert(subresource_map);
353 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
354 }
John Zulauff660ad62019-03-23 07:16:05 -0600355}
356
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600357void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600358 VkImageLayout layout) {
359 const IMAGE_STATE *image_state = GetImageState(image);
360 if (!image_state) return;
361 SetImageInitialLayout(cb_node, *image_state, range, layout);
362};
363
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600364void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600365 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
366 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600367}
Dave Houltonddd65c52018-05-08 14:58:01 -0600368
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600369// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700370void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
371 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500372 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600373
John Zulauff660ad62019-03-23 07:16:05 -0600374 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600375 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
376 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600377 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 -0600378 sub_range.baseArrayLayer = 0;
379 sub_range.layerCount = image_state->createInfo.extent.depth;
380 }
381
Piers Daniell4fde9b72019-11-27 16:19:46 -0700382 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
383 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
384 SetImageLayout(cb_node, *image_state, sub_range, layout);
385 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
386 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
387 } else {
388 SetImageLayout(cb_node, *image_state, sub_range, layout);
389 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600390}
391
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700392bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
393 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700394 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600395 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100396 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700397 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100398 const char *vuid;
399 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700400 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100401
402 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600403 LogObjectList objlist(image);
404 objlist.add(renderpass);
405 objlist.add(framebuffer);
406 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700407 skip |=
408 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
409 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
410 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
411 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100412 return skip;
413 }
414
415 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200416 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
417 if (stencil_usage_info) {
418 image_usage |= stencil_usage_info->stencilUsage;
419 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100420
421 // Check for layouts that mismatch image usages in the framebuffer
422 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800423 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600424 LogObjectList objlist(image);
425 objlist.add(renderpass);
426 objlist.add(framebuffer);
427 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700428 skip |= LogError(objlist, vuid,
429 "%s: Layout/usage mismatch for attachment %u in %s"
430 " - the %s is %s but the image attached to %s via %s"
431 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
432 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
433 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
434 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100435 }
436
437 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
438 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800439 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600440 LogObjectList objlist(image);
441 objlist.add(renderpass);
442 objlist.add(framebuffer);
443 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700444 skip |= LogError(objlist, vuid,
445 "%s: Layout/usage mismatch for attachment %u in %s"
446 " - the %s is %s but the image attached to %s via %s"
447 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
448 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
449 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
450 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100451 }
452
453 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800454 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600455 LogObjectList objlist(image);
456 objlist.add(renderpass);
457 objlist.add(framebuffer);
458 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700459 skip |= LogError(objlist, vuid,
460 "%s: Layout/usage mismatch for attachment %u in %s"
461 " - the %s is %s but the image attached to %s via %s"
462 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
463 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
464 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
465 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100466 }
467
468 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800469 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600470 LogObjectList objlist(image);
471 objlist.add(renderpass);
472 objlist.add(framebuffer);
473 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700474 skip |= LogError(objlist, vuid,
475 "%s: Layout/usage mismatch for attachment %u in %s"
476 " - the %s is %s but the image attached to %s via %s"
477 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
478 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
479 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
480 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100481 }
482
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600483 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100484 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
485 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
486 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
487 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
488 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800489 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600490 LogObjectList objlist(image);
491 objlist.add(renderpass);
492 objlist.add(framebuffer);
493 objlist.add(image_view);
494 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700495 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700496 " - the %s is %s but the image attached to %s via %s"
497 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700498 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700499 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
500 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100501 }
502 } else {
503 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
504 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
505 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
506 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600507 LogObjectList objlist(image);
508 objlist.add(renderpass);
509 objlist.add(framebuffer);
510 objlist.add(image_view);
511 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700512 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700513 " - the %s is %s but the image attached to %s via %s"
514 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700515 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700516 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
517 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100518 }
519 }
520 return skip;
521}
522
John Zulauf17a01bb2019-08-09 16:41:19 -0600523bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700524 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600525 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600526 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700527 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700528 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100529 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100530
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700531 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100532 auto framebuffer = framebuffer_state->framebuffer;
533
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700534 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700535 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
536 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700537 }
John Zulauf8e308292018-09-21 11:34:37 -0600538
Tobias Hectorc9057422019-07-23 12:15:52 +0100539 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
540 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
541 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100542 }
543
Tobias Hectorc9057422019-07-23 12:15:52 +0100544 if (attachments != nullptr) {
545 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
546 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
547 auto image_view = attachments[i];
548 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100549
Tobias Hectorc9057422019-07-23 12:15:52 +0100550 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600551 LogObjectList objlist(pRenderPassBegin->renderPass);
552 objlist.add(framebuffer_state->framebuffer);
553 objlist.add(image_view);
554 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700555 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
556 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
557 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100558 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100559 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100560
561 const VkImage image = view_state->create_info.image;
562 const IMAGE_STATE *image_state = GetImageState(image);
563
564 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600565 LogObjectList objlist(pRenderPassBegin->renderPass);
566 objlist.add(framebuffer_state->framebuffer);
567 objlist.add(image_view);
568 objlist.add(image);
569 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700570 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
571 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
572 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100573 continue;
574 }
575 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
576 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
577
Piers Daniell7f894f62020-01-09 16:33:48 -0700578 // Default to expecting stencil in the same layout.
579 auto attachment_stencil_initial_layout = attachment_initial_layout;
580
581 // If a separate layout is specified, look for that.
582 const auto *attachment_description_stencil_layout =
583 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
584 if (attachment_description_stencil_layout) {
585 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
586 }
587
Tobias Hectorc9057422019-07-23 12:15:52 +0100588 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
589 // in common with the non-const version.)
590 const ImageSubresourceLayoutMap *subresource_map =
591 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
592
593 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
594 LayoutUseCheckAndMessage layout_check(subresource_map);
595 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700596 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
597 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
598 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700599
John Zulauf5e617452019-11-19 14:44:16 -0700600 // Allow for differing depth and stencil layouts
601 VkImageLayout check_layout = attachment_initial_layout;
602 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
603
604 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700605 subres_skip |= LogError(
606 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700607 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
608 "and the %s layout of the attachment is %s. The layouts must match, or the render "
609 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700610 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100611 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700612 }
John Zulauf5e617452019-11-19 14:44:16 -0700613
Tobias Hectorc9057422019-07-23 12:15:52 +0100614 skip |= subres_skip;
615 }
616
617 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
618 framebuffer, render_pass, i, "initial layout");
619
620 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
621 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100622 }
623
Tobias Hectorc9057422019-07-23 12:15:52 +0100624 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
625 auto &subpass = pRenderPassInfo->pSubpasses[j];
626 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
627 auto &attachment_ref = subpass.pInputAttachments[k];
628 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
629 auto image_view = attachments[attachment_ref.attachment];
630 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100631
Tobias Hectorc9057422019-07-23 12:15:52 +0100632 if (view_state) {
633 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700634 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
635 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100636 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100637 }
638 }
639 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100640
Tobias Hectorc9057422019-07-23 12:15:52 +0100641 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
642 auto &attachment_ref = subpass.pColorAttachments[k];
643 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
644 auto image_view = attachments[attachment_ref.attachment];
645 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100646
Tobias Hectorc9057422019-07-23 12:15:52 +0100647 if (view_state) {
648 auto image = view_state->create_info.image;
649 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
650 framebuffer, render_pass, attachment_ref.attachment,
651 "color attachment layout");
652 if (subpass.pResolveAttachments) {
653 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
654 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
655 attachment_ref.attachment, "resolve attachment layout");
656 }
657 }
658 }
659 }
660
661 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
662 auto &attachment_ref = *subpass.pDepthStencilAttachment;
663 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
664 auto image_view = attachments[attachment_ref.attachment];
665 auto view_state = GetImageViewState(image_view);
666
667 if (view_state) {
668 auto image = view_state->create_info.image;
669 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
670 framebuffer, render_pass, attachment_ref.attachment,
671 "input attachment layout");
672 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100673 }
674 }
675 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700676 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600677 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700678}
679
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600680void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700681 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700682 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700683 IMAGE_VIEW_STATE *image_view = nullptr;
684 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
685 const auto attachment_info =
686 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
687 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
688 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300689 image_view = GetAttachmentImageViewState(pCB, pFramebuffer, ref.attachment);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700690 }
John Zulauf8e308292018-09-21 11:34:37 -0600691 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700692 VkImageLayout stencil_layout = kInvalidLayout;
693 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
694 if (attachment_reference_stencil_layout) {
695 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
696 }
697
698 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600699 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700700 }
701}
702
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600703void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
704 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700705 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700706
707 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700708 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700709 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700710 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700711 }
712 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700713 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700714 }
715 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700716 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700717 }
718 }
719}
720
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700721// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
722// 1. Transition into initialLayout state
723// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600724void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700725 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700726 // First transition into initialLayout
727 auto const rpci = render_pass_state->createInfo.ptr();
728 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700729 IMAGE_VIEW_STATE *view_state = nullptr;
730 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
731 const auto attachment_info =
732 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
733 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
734 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300735 view_state = GetAttachmentImageViewState(cb_state, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700736 }
John Zulauf8e308292018-09-21 11:34:37 -0600737 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700738 VkImageLayout stencil_layout = kInvalidLayout;
739 const auto *attachment_description_stencil_layout =
740 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
741 if (attachment_description_stencil_layout) {
742 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
743 }
744
745 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600746 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700747 }
748 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700749 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700750}
751
Dave Houlton10b39482017-03-16 13:18:15 -0600752bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600753 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600754 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600755 }
756 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600757 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600758 }
759 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600760 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600761 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700762 if (0 !=
763 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
764 if (FormatPlaneCount(format) == 1) return false;
765 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600766 return true;
767}
768
Mike Weiblen62d08a32017-03-07 22:18:27 -0700769// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200770bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
771 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600772 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700773 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200774 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600775 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700776
777 switch (layout) {
778 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
779 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600780 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700781 }
782 break;
783 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
784 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600785 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700786 }
787 break;
788 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
789 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600790 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700791 }
792 break;
793 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
794 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600795 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700796 }
797 break;
798 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
799 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600800 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700801 }
802 break;
803 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
804 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600805 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700806 }
807 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600808 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500809 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
810 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
811 }
812 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700813 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
814 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
815 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
816 }
817 break;
818 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
819 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
820 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
821 }
822 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700823 default:
824 // Other VkImageLayout values do not have VUs defined in this context.
825 break;
826 }
827
Dave Houlton8e9f6542018-05-18 12:18:22 -0600828 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700829 skip |= LogError(img_barrier.image, msg_code,
830 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
831 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
832 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700833 }
834 return skip;
835}
836
837// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600838bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
839 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700840 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700841
Petr Krausad0096a2019-08-09 18:35:04 +0200842 // Scoreboard for checking for duplicate and inconsistent barriers to images
843 struct ImageBarrierScoreboardEntry {
844 uint32_t index;
845 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
846 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
847 const VkImageMemoryBarrier *barrier;
848 };
849 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
850 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
851
John Zulauf463c51e2018-05-31 13:29:20 -0600852 // Scoreboard for duplicate layout transition barriers within the list
853 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
854 ImageBarrierScoreboardImageMap layout_transitions;
855
Mike Weiblen62d08a32017-03-07 22:18:27 -0700856 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200857 const auto &img_barrier = pImageMemoryBarriers[i];
858 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700859
John Zulauf463c51e2018-05-31 13:29:20 -0600860 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
861 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
862 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200863 if (img_barrier.oldLayout != img_barrier.newLayout) {
864 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
865 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600866 if (image_it != layout_transitions.end()) {
867 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200868 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600869 if (subres_it != subres_map.end()) {
870 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200871 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
872 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
873 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700874 skip = LogError(
875 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200876 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600877 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
878 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200879 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
880 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
881 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600882 }
883 entry = new_entry;
884 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200885 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600886 }
887 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200888 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600889 }
890 }
891
Petr Krausad0096a2019-08-09 18:35:04 +0200892 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600893 if (image_state) {
894 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200895 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
896 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600897
898 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
899 if (image_state->layout_locked) {
900 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700901 skip |= LogError(
902 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700903 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600904 " 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 -0700905 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200906 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600907 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600908
John Zulaufa4472282019-08-22 14:44:34 -0600909 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700910 const VkFormat image_format = image_create_info.format;
911 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600912 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700913 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700914 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600915 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
916 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700917 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
918 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
919 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
920 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700921 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600922 }
923 } else {
924 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
925 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -0700926 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
927 ? "VUID-VkImageMemoryBarrier-image-03320"
928 : "VUID-VkImageMemoryBarrier-image-01207";
929 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700930 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
931 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
932 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700933 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600934 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700935 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700936 }
John Zulauff660ad62019-03-23 07:16:05 -0600937
Petr Krausad0096a2019-08-09 18:35:04 +0200938 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
939 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600940 // TODO: Set memory invalid which is in mem_tracker currently
941 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
942 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600943 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600944 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600945 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200946 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700947 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
948 const auto &value = *pos;
949 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700950 subres_skip = LogError(
951 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700952 "%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 -0700953 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700954 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -0700955 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
956 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600957 }
John Zulauf5e617452019-11-19 14:44:16 -0700958 }
John Zulauff660ad62019-03-23 07:16:05 -0600959 skip |= subres_skip;
960 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700961
962 // checks color format and (single-plane or non-disjoint)
963 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
964 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700965 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700966 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
967 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
968 ? "VUID-VkImageMemoryBarrier-image-01671"
969 : "VUID-VkImageMemoryBarrier-image-02902";
970 skip |= LogError(img_barrier.image, vuid,
971 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
972 "but its aspectMask is 0x%" PRIx32 ".",
973 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
974 string_VkFormat(image_format), aspect_mask);
975 }
976 }
977
978 VkImageAspectFlags valid_disjoint_mask =
979 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 -0700980 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -0700981 ((aspect_mask & valid_disjoint_mask) == 0)) {
982 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
983 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
984 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
985 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
986 string_VkFormat(image_format), aspect_mask);
987 }
988
989 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
990 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
991 "%s: Image barrier %s references %s of format %s has only two planes but included "
992 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
993 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
994 string_VkFormat(image_format), aspect_mask);
995 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700996 }
997 }
998 return skip;
999}
1000
John Zulaufe3d1c8a2019-08-12 14:34:58 -06001001bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +02001002 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -07001003
Jeff Bolz6835fda2019-10-06 00:15:34 -05001004 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +02001005 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001006}
1007
John Zulauf6b4aae82018-05-09 13:03:36 -06001008template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001009bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
1010 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001011 using BarrierRecord = QFOTransferBarrier<Barrier>;
1012 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001013 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001014 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
1015 const char *barrier_name = BarrierRecord::BarrierName();
1016 const char *handle_name = BarrierRecord::HandleName();
1017 const char *transfer_type = nullptr;
1018 for (uint32_t b = 0; b < barrier_count; b++) {
1019 if (!IsTransferOp(&barriers[b])) continue;
1020 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001021 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001022 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001023 const auto found = barrier_sets.release.find(barriers[b]);
1024 if (found != barrier_sets.release.cend()) {
1025 barrier_record = &(*found);
1026 transfer_type = "releasing";
1027 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -06001028 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001029 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001030 const auto found = barrier_sets.acquire.find(barriers[b]);
1031 if (found != barrier_sets.acquire.cend()) {
1032 barrier_record = &(*found);
1033 transfer_type = "acquiring";
1034 }
1035 }
1036 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001037 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
1038 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1039 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
1040 func_name, barrier_name, b, transfer_type, handle_name,
1041 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
1042 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001043 }
1044 }
1045 return skip;
1046}
1047
John Zulaufa4472282019-08-22 14:44:34 -06001048VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1049 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1050}
1051
1052const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1053 return device_state.GetImageState(barrier.image);
1054}
1055
1056VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1057 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1058}
1059
1060const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1061 return device_state.GetBufferState(barrier.buffer);
1062}
1063
1064VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1065
John Zulauf6b4aae82018-05-09 13:03:36 -06001066template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001067void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1068 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001069 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001070 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1071 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001072 auto &barrier = barriers[b];
1073 if (IsTransferOp(&barrier)) {
1074 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001075 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001076 barrier_sets.release.emplace(barrier);
1077 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001078 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001079 barrier_sets.acquire.emplace(barrier);
1080 }
1081 }
1082
1083 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1084 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1085 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1086 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1087 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1088 auto handle_state = BarrierHandleState(*this, barrier);
1089 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1090 if (!mode_concurrent) {
1091 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001092 cb_state->queue_submit_functions.emplace_back(
1093 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1094 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1095 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1096 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001097 });
1098 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001099 }
1100 }
1101}
1102
John Zulaufa4472282019-08-22 14:44:34 -06001103bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001104 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001105 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001106 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001107 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001108 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1109 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001110 return skip;
1111}
1112
John Zulaufa4472282019-08-22 14:44:34 -06001113void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1114 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1115 const VkImageMemoryBarrier *pImageMemBarriers) {
1116 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1117 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001118}
1119
1120template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001121bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001122 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001123 // Record to the scoreboard or report that we have a duplication
1124 bool skip = false;
1125 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1126 if (!inserted.second && inserted.first->second != cb_state) {
1127 // 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 -06001128 LogObjectList objlist(cb_state->commandBuffer);
1129 objlist.add(barrier.handle);
1130 objlist.add(inserted.first->second->commandBuffer);
1131 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001132 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1133 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1134 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1135 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1136 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001137 }
1138 return skip;
1139}
1140
1141template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001142bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1143 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001144 using BarrierRecord = QFOTransferBarrier<Barrier>;
1145 using TypeTag = typename BarrierRecord::Tag;
1146 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001147 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001148 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001149 const char *barrier_name = BarrierRecord::BarrierName();
1150 const char *handle_name = BarrierRecord::HandleName();
1151 // No release should have an extant duplicate (WARNING)
1152 for (const auto &release : cb_barriers.release) {
1153 // Check the global pending release barriers
1154 const auto set_it = global_release_barriers.find(release.handle);
1155 if (set_it != global_release_barriers.cend()) {
1156 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1157 const auto found = set_for_handle.find(release);
1158 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001159 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1160 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1161 " to dstQueueFamilyIndex %" PRIu32
1162 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1163 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1164 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001165 }
1166 }
1167 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1168 }
1169 // Each acquire must have a matching release (ERROR)
1170 for (const auto &acquire : cb_barriers.acquire) {
1171 const auto set_it = global_release_barriers.find(acquire.handle);
1172 bool matching_release_found = false;
1173 if (set_it != global_release_barriers.cend()) {
1174 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1175 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1176 }
1177 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001178 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1179 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1180 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1181 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1182 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001183 }
1184 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1185 }
1186 return skip;
1187}
1188
John Zulauf3b04ebd2019-07-18 14:08:11 -06001189bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001190 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001191 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001192 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001193 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1194 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001195 return skip;
1196}
1197
1198template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001199void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001200 using BarrierRecord = QFOTransferBarrier<Barrier>;
1201 using TypeTag = typename BarrierRecord::Tag;
1202 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001203 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001204
1205 // Add release barriers from this submit to the global map
1206 for (const auto &release : cb_barriers.release) {
1207 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1208 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1209 global_release_barriers[release.handle].insert(release);
1210 }
1211
1212 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1213 for (const auto &acquire : cb_barriers.acquire) {
1214 // NOTE: We're not using [] because we don't want to create entries for missing releases
1215 auto set_it = global_release_barriers.find(acquire.handle);
1216 if (set_it != global_release_barriers.end()) {
1217 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1218 set_for_handle.erase(acquire);
1219 if (set_for_handle.size() == 0) { // Clean up empty sets
1220 global_release_barriers.erase(set_it);
1221 }
1222 }
1223 }
1224}
1225
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001226void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001227 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1228 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001229}
1230
John Zulauf6b4aae82018-05-09 13:03:36 -06001231// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001232void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001233
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001234void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001235 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001236 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001237 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001238
Chris Forbes4de4b132017-08-21 11:27:08 -07001239 // For ownership transfers, the barrier is specified twice; as a release
1240 // operation on the yielding queue family, and as an acquire operation
1241 // on the acquiring queue family. This barrier may also include a layout
1242 // transition, which occurs 'between' the two operations. For validation
1243 // purposes it doesn't seem important which side performs the layout
1244 // transition, but it must not be performed twice. We'll arbitrarily
1245 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001246 //
1247 // However, we still need to record initial layout for the "initial layout" validation
1248 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001249
Petr Krausad0096a2019-08-09 18:35:04 +02001250 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001251 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001252 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001253 }
1254}
1255
unknown86bcb3a2019-07-11 13:05:36 -06001256void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001257 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001258 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1259 const auto &image_create_info = image_state->createInfo;
1260
1261 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1262 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1263 // for all (potential) layer sub_resources.
1264 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1265 normalized_isr.baseArrayLayer = 0;
1266 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1267 }
1268
Michael Spang8af7c102020-05-03 20:50:09 -04001269 VkImageLayout initial_layout = mem_barrier.oldLayout;
1270
1271 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001272 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001273 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1274 }
1275
John Zulauf2be3fe02019-12-30 09:48:02 -07001276 if (is_release_op) {
1277 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1278 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001279 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001280 }
unknown86bcb3a2019-07-11 13:05:36 -06001281}
1282
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001283bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1284 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1285 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1286 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001287 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001288 assert(cb_node);
1289 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001290 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001291 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001292
John Zulauff660ad62019-03-23 07:16:05 -06001293 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1294 if (subresource_map) {
1295 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001296 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001297 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1298 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001299 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001300 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1301 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1302 "%s layout %s.",
1303 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1304 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1305 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001306 }
John Zulauf5e617452019-11-19 14:44:16 -07001307 }
John Zulauff660ad62019-03-23 07:16:05 -06001308 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001309 }
John Zulauff660ad62019-03-23 07:16:05 -06001310
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001311 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1312 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1313 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001314 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1315 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001316 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1317 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1318 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001319 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001320 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001321 if (image_state->shared_presentable) {
1322 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001323 skip |=
1324 LogError(device, layout_invalid_msg_code,
1325 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1326 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001327 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001328 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001329 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001330 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001331 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1332 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1333 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1334 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001335 }
1336 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001337 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001338}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001339bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001340 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1341 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001342 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001343 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1344 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1345}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001346
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001347void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001348 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001349 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001350 if (!renderPass) return;
1351
Tobias Hectorbbb12282018-10-22 15:17:59 +01001352 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001353 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001354 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001355 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001356 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1357 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1358 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1359 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001360 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001361 }
John Zulauf8e308292018-09-21 11:34:37 -06001362 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001363 VkImageLayout stencil_layout = kInvalidLayout;
1364 const auto *attachment_description_stencil_layout =
1365 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1366 if (attachment_description_stencil_layout) {
1367 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1368 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001369 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001370 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001371 }
1372 }
1373}
Dave Houltone19e20d2018-02-02 16:32:41 -07001374
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001375#ifdef VK_USE_PLATFORM_ANDROID_KHR
1376// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1377// This could also move into a seperate core_validation_android.cpp file... ?
1378
1379//
1380// AHB-specific validation within non-AHB APIs
1381//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001382bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001383 bool skip = false;
1384
1385 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1386 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001387 if (0 != ext_fmt_android->externalFormat) {
1388 if (VK_FORMAT_UNDEFINED != create_info->format) {
1389 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001390 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1391 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1392 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001393 }
1394
1395 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001396 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1397 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1398 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001399 }
1400
1401 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001402 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1403 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001404 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1405 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1406 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001407 }
1408
1409 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001410 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1411 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1412 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001413 }
1414 }
1415
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001416 if ((0 != ext_fmt_android->externalFormat) &&
1417 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001418 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001419 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1420 ") which has "
1421 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1422 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001423 }
1424 }
1425
Dave Houltond9611312018-11-19 17:03:36 -07001426 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001427 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001428 skip |=
1429 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1430 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1431 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001432 }
1433 }
1434
1435 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1436 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1437 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001438 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001439 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1440 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1441 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1442 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001443 }
1444
1445 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001446 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1447 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1448 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1449 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1450 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001451 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001452 }
1453
1454 return skip;
1455}
1456
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001457bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001458 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001459 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001460
1461 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001462 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001463 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1464 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001465 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001466 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001467 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001468
Dave Houltond9611312018-11-19 17:03:36 -07001469 // Chain must include a compatible ycbcr conversion
1470 bool conv_found = false;
1471 uint64_t external_format = 0;
1472 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1473 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001474 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001475 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001476 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001477 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001478 }
Dave Houltond9611312018-11-19 17:03:36 -07001479 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001480 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001481 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001482 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1483 "an externalFormat (%" PRIu64
1484 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1485 "with the same external format.",
1486 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001487 }
1488
1489 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001490 if (IsIdentitySwizzle(create_info->components) == false) {
1491 skip |= LogError(
1492 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1493 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1494 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1495 "= %s.",
1496 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1497 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001498 }
1499 }
Dave Houltond9611312018-11-19 17:03:36 -07001500
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001501 return skip;
1502}
1503
John Zulaufa26d3c82019-08-14 16:09:08 -06001504bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001505 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001506
John Zulaufa26d3c82019-08-14 16:09:08 -06001507 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001508 if (image_state != nullptr) {
1509 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1510 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1511 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1512 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1513 "bound to memory.");
1514 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001515 }
1516 return skip;
1517}
1518
1519#else
1520
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001521bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001522 return false;
1523}
1524
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001525bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001526
John Zulaufa26d3c82019-08-14 16:09:08 -06001527bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001528
1529#endif // VK_USE_PLATFORM_ANDROID_KHR
1530
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001531bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1532 bool skip = false;
1533
1534 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1535 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1536 const VkImageTiling image_tiling = pCreateInfo->tiling;
1537 const VkFormat image_format = pCreateInfo->format;
1538
1539 if (image_format == VK_FORMAT_UNDEFINED) {
1540 // VU 01975 states format can't be undefined unless an android externalFormat
1541#ifdef VK_USE_PLATFORM_ANDROID_KHR
1542 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1543 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1544 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1545 if (it != ahb_ext_formats_map.end()) {
1546 tiling_features = it->second;
1547 }
1548 }
1549#endif
1550 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1551 uint64_t drm_format_modifier = 0;
1552 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1553 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1554 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1555 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1556
1557 if (drm_explicit != nullptr) {
1558 drm_format_modifier = drm_explicit->drmFormatModifier;
1559 } else {
1560 // VUID 02261 makes sure its only explict or implict in parameter checking
1561 assert(drm_implicit != nullptr);
1562 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1563 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1564 }
1565 }
1566
1567 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1568 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1569 nullptr};
1570 format_properties_2.pNext = (void *)&drm_properties_list;
1571 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001572 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1573 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1574 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1575 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001576
1577 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1578 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1579 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1580 }
1581 }
1582 } else {
1583 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1584 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1585 : format_properties.optimalTilingFeatures;
1586 }
1587
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001588 // Lack of disjoint format feature support while using the flag
1589 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1590 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1591 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1592 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1593 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1594 string_VkFormat(pCreateInfo->format));
1595 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001596
1597 return skip;
1598}
1599
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001600bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001601 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001602 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001603
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001604 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001605 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001606 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1607 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001608 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1609 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001610 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001611 }
1612
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001613 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1614 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001615 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1616 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1617 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001618 }
1619
1620 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001621 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1622 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1623 "height (%d) and arrayLayers (%d) must be >= 6.",
1624 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001625 }
Dave Houlton130c0212018-01-29 13:39:56 -07001626 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001627
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001628 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001629 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1630 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1631 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001632 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1633 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1634 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001635 }
1636
1637 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001638 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1639 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1640 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001641 }
1642
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001643 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
ByumjinConffx991b6062019-08-14 15:17:53 -07001644 uint32_t ceiling_width =
1645 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1646 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1647 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1648 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001649 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1650 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1651 "ceiling of device "
1652 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1653 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1654 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001655 }
1656
1657 uint32_t ceiling_height =
1658 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1659 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1660 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1661 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001662 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1663 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1664 "ceiling of device "
1665 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1666 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1667 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001668 }
1669 }
1670
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001671 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001672 VkResult result = VK_SUCCESS;
1673 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1674 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1675 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1676 &format_limits);
1677 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001678 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1679 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1680 if (modifier_list) {
1681 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1682 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1683 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1684 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1685 image_format_info.type = pCreateInfo->imageType;
1686 image_format_info.format = pCreateInfo->format;
1687 image_format_info.tiling = pCreateInfo->tiling;
1688 image_format_info.usage = pCreateInfo->usage;
1689 image_format_info.flags = pCreateInfo->flags;
1690 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1691
1692 result =
1693 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1694 format_limits = image_format_properties.imageFormatProperties;
1695
1696 /* The application gives a list of modifier and the driver
1697 * selects one. If one is wrong, stop there.
1698 */
1699 if (result != VK_SUCCESS) break;
1700 }
1701 } else if (explicit_modifier) {
1702 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1703 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1704 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1705 image_format_info.type = pCreateInfo->imageType;
1706 image_format_info.format = pCreateInfo->format;
1707 image_format_info.tiling = pCreateInfo->tiling;
1708 image_format_info.usage = pCreateInfo->usage;
1709 image_format_info.flags = pCreateInfo->flags;
1710 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1711
1712 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1713 format_limits = image_format_properties.imageFormatProperties;
1714 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001715 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001716
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001717 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1718 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1719 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1720 if (result != VK_SUCCESS) {
1721 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001722#ifdef VK_USE_PLATFORM_ANDROID_KHR
1723 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1724#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001725 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001726 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001727 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1728 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001729 } else {
1730 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1731 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001732 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1733 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1734 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001735 }
Dave Houlton130c0212018-01-29 13:39:56 -07001736
Dave Houltona585d132019-01-18 13:05:42 -07001737 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1738 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1739 (uint64_t)pCreateInfo->samples;
1740 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001741
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001742 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001743 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001744 uint64_t ig_mask = imageGranularity - 1;
1745 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001746
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001747 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001748 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1749 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1750 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1751 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001752 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001753
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001754 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001755 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1756 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1757 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001758 }
1759
1760 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001761 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1762 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1763 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001764 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001765
1766 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1767 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1768 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1769 pCreateInfo->extent.width, format_limits.maxExtent.width);
1770 }
1771
1772 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1773 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1774 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1775 pCreateInfo->extent.height, format_limits.maxExtent.height);
1776 }
1777
1778 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1779 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1780 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1781 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1782 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001783 }
1784
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001785 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001786 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1787 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1788 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1789 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001790 skip |= LogError(device, error_vuid,
1791 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1792 "YCbCr Conversion format, arrayLayers must be 1",
1793 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001794 }
1795
1796 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001797 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1798 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1799 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001800 }
1801
1802 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001803 skip |= LogError(
1804 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001805 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1806 string_VkSampleCountFlagBits(pCreateInfo->samples));
1807 }
1808
1809 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001810 skip |= LogError(
1811 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001812 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1813 string_VkImageType(pCreateInfo->imageType));
1814 }
1815 }
1816
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001817 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001818 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001819 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001820 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001821 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1822 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1823 "format must be block, ETC or ASTC compressed, but is %s",
1824 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001825 }
1826 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001827 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1828 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1829 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001830 }
1831 }
1832 }
1833
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001834 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001835 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1836 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
1837 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001838 }
1839
unknown2c877272019-07-11 12:56:50 -06001840 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1841 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1842 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001843 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1844 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1845 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001846 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001847
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001848 const auto swapchain_create_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1849 if (swapchain_create_info != nullptr) {
1850 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1851 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1852 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1853
1854 // Validate rest of Swapchain Image create check that require swapchain state
1855 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1856 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1857 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1858 skip |= LogError(
1859 device, vuid,
1860 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1861 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1862 }
1863 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1864 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1865 skip |= LogError(device, vuid,
1866 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1867 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1868 }
1869 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR);
1870 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1871 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1872 skip |= LogError(device, vuid,
1873 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1874 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
1875 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR flags both set.");
1876 }
1877 }
1878 }
1879
sfricke-samsungedce77a2020-07-03 22:35:13 -07001880 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1881 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1882 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1883 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1884 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1885 }
1886 const VkImageCreateFlags invalid_flags =
1887 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1888 if ((pCreateInfo->flags & invalid_flags) != 0) {
1889 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1890 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1891 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1892 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1893 }
1894 }
1895
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001896 skip |= ValidateImageFormatFeatures(pCreateInfo);
1897
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001898 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001899}
1900
John Zulauf7eeb6f72019-06-17 11:56:36 -06001901void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1902 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1903 if (VK_SUCCESS != result) return;
1904
1905 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001906 auto image_state = Get<IMAGE_STATE>(*pImage);
1907 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001908}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001909
Jeff Bolz5c801d12019-10-09 10:38:45 -05001910bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001911 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001912 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001913 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001914 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001915 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001916 }
1917 return skip;
1918}
1919
John Zulauf7eeb6f72019-06-17 11:56:36 -06001920void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1921 // Clean up validation specific data
1922 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001923
locke-lunargcba7d5f2019-12-30 16:59:11 -07001924 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001925
1926 // Clean up generic image state
1927 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001928}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001929
sfricke-samsungcd924d92020-05-20 23:51:17 -07001930bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
1931 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001932 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07001933 const VkImage image = image_state->image;
1934 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001935
1936 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001937 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
1938 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001939 }
1940
sfricke-samsungcd924d92020-05-20 23:51:17 -07001941 if (FormatIsDepthOrStencil(format)) {
1942 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1943 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
1944 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
1945 } else if (FormatIsCompressed(format)) {
1946 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1947 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
1948 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001949 }
1950
1951 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001952 skip |=
1953 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
1954 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
1955 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001956 }
1957 return skip;
1958}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001959
John Zulauf07288512019-07-05 11:09:50 -06001960bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1961 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1962 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001963 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001964 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1965 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001966 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1967 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1968 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001969 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001970
1971 } else {
1972 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1973 if (!device_extensions.vk_khr_shared_presentable_image) {
1974 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001975 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
1976 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1977 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001978 }
1979 } else {
1980 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1981 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001982 skip |= LogError(
1983 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001984 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1985 func_name, string_VkImageLayout(dest_image_layout));
1986 }
1987 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001988 }
1989
John Zulauff660ad62019-03-23 07:16:05 -06001990 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001991 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001992 if (subresource_map) {
1993 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001994 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001995 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001996 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1997 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001998 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1999 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2000 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2001 } else {
2002 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002003 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002004 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2005 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2006 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2007 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002008 }
John Zulauf5e617452019-11-19 14:44:16 -07002009 }
John Zulauff660ad62019-03-23 07:16:05 -06002010 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002011 }
2012
2013 return skip;
2014}
2015
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002016bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2017 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002018 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002019 bool skip = false;
2020 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002021 const auto *cb_node = GetCBState(commandBuffer);
2022 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002023 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002024 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002025 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002026 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002027 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002028 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002029 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2030 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002031 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002032 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002033 skip |=
2034 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2035 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2036 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002037 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002038 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002039 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002040 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002041 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002042 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002043 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2044 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2045 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2046 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2047 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2048 string_VkFormat(image_state->createInfo.format));
2049 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002050 }
2051 return skip;
2052}
2053
John Zulaufeabb4462019-07-05 14:13:03 -06002054void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2055 const VkClearColorValue *pColor, uint32_t rangeCount,
2056 const VkImageSubresourceRange *pRanges) {
2057 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2058
2059 auto cb_node = GetCBState(commandBuffer);
2060 auto image_state = GetImageState(image);
2061 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002062 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002063 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002064 }
2065 }
2066}
2067
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002068bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2069 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002070 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002071 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002072
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002073 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002074 const auto *cb_node = GetCBState(commandBuffer);
2075 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002076 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002077 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002078 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002079 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002080 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002081 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002082 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002083 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002084 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002085 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002086 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002087 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002088 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2089 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2090 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2091 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002092
2093 bool any_include_aspect_depth_bit = false;
2094 bool any_include_aspect_stencil_bit = false;
2095
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002096 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002097 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002098 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002099 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002100 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002101 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2102 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002103 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2104 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2105 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2106 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002107 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002108 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2109 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002110 if (FormatHasDepth(image_format) == false) {
2111 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2112 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2113 "doesn't have a depth component.",
2114 i, string_VkFormat(image_format));
2115 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002116 }
2117 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2118 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002119 if (FormatHasStencil(image_format) == false) {
2120 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2121 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2122 "%s doesn't have a stencil component.",
2123 i, string_VkFormat(image_format));
2124 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002125 }
2126 }
2127 if (any_include_aspect_stencil_bit) {
2128 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2129 if (image_stencil_struct != nullptr) {
2130 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2131 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002132 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2133 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2134 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2135 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002136 }
2137 } else {
2138 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002139 skip |= LogError(
2140 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002141 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2142 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2143 "in VkImageCreateInfo::usage used to create image");
2144 }
2145 }
2146 }
2147 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002148 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2149 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2150 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002151 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002152 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002153 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2154 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002155 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002156 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002157 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002158 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2159 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2160 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2161 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002162 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002163 }
2164 return skip;
2165}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002166
John Zulaufeabb4462019-07-05 14:13:03 -06002167void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2168 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2169 const VkImageSubresourceRange *pRanges) {
2170 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2171 auto cb_node = GetCBState(commandBuffer);
2172 auto image_state = GetImageState(image);
2173 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002174 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002175 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002176 }
2177 }
2178}
2179
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002180// Returns true if [x, xoffset] and [y, yoffset] overlap
2181static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2182 bool result = false;
2183 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2184 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2185
2186 if (intersection_max > intersection_min) {
2187 result = true;
2188 }
2189 return result;
2190}
2191
Dave Houltonc991cc92018-03-06 11:08:51 -07002192// Returns true if source area of first copy region intersects dest area of second region
2193// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2194static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002195 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002196
Dave Houltonc991cc92018-03-06 11:08:51 -07002197 // Separate planes within a multiplane image cannot intersect
2198 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002199 return result;
2200 }
2201
Dave Houltonc991cc92018-03-06 11:08:51 -07002202 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2203 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2204 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002205 result = true;
2206 switch (type) {
2207 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002208 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002209 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002210 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002211 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002212 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002213 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002214 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002215 break;
2216 default:
2217 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2218 assert(false);
2219 }
2220 }
2221 return result;
2222}
2223
Dave Houltonfc1a4052017-04-27 14:32:45 -06002224// Returns non-zero if offset and extent exceed image extents
2225static const uint32_t x_bit = 1;
2226static const uint32_t y_bit = 2;
2227static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002228static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002229 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002230 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002231 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2232 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002233 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002234 }
2235 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2236 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002237 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002238 }
2239 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2240 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002241 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002242 }
2243 return result;
2244}
2245
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002246// Test if two VkExtent3D structs are equivalent
2247static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2248 bool result = true;
2249 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2250 (extent->depth != other_extent->depth)) {
2251 result = false;
2252 }
2253 return result;
2254}
2255
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002256// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002257static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002258 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2259}
2260
2261// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002262VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002263 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2264 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002265 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002266 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002267 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002268 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002269 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002270 granularity.width *= block_size.width;
2271 granularity.height *= block_size.height;
2272 }
2273 }
2274 return granularity;
2275}
2276
2277// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2278static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2279 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002280 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2281 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002282 valid = false;
2283 }
2284 return valid;
2285}
2286
2287// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002288bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002289 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002290 bool skip = false;
2291 VkExtent3D offset_extent = {};
2292 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2293 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2294 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002295 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002296 // 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 -07002297 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002298 skip |= LogError(cb_node->commandBuffer, vuid,
2299 "%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 "
2300 "image transfer granularity is (w=0, h=0, d=0).",
2301 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002302 }
2303 } else {
2304 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2305 // integer multiples of the image transfer granularity.
2306 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002307 skip |= LogError(cb_node->commandBuffer, vuid,
2308 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2309 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2310 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2311 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002312 }
2313 }
2314 return skip;
2315}
2316
2317// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002318bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002319 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002320 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002321 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002322 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002323 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2324 // subresource extent.
2325 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002326 skip |= LogError(cb_node->commandBuffer, vuid,
2327 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2328 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2329 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2330 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002331 }
2332 } else {
2333 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2334 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2335 // subresource extent dimensions.
2336 VkExtent3D offset_extent_sum = {};
2337 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2338 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2339 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002340 bool x_ok = true;
2341 bool y_ok = true;
2342 bool z_ok = true;
2343 switch (image_type) {
2344 case VK_IMAGE_TYPE_3D:
2345 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2346 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002347 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002348 case VK_IMAGE_TYPE_2D:
2349 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2350 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002351 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002352 case VK_IMAGE_TYPE_1D:
2353 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2354 (subresource_extent->width == offset_extent_sum.width));
2355 break;
2356 default:
2357 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2358 assert(false);
2359 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002360 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002361 skip |=
2362 LogError(cb_node->commandBuffer, vuid,
2363 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2364 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2365 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2366 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2367 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2368 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002369 }
2370 }
2371 return skip;
2372}
2373
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002374bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002375 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002376 bool skip = false;
2377 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002378 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2379 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002380 }
2381 return skip;
2382}
2383
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002384bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002385 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002386 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002387 bool skip = false;
2388 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2389 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002390 skip |= LogError(cb_node->commandBuffer, vuid,
2391 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2392 "%u, but provided %s has %u array layers.",
2393 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2394 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002395 }
2396 return skip;
2397}
2398
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002399// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002400bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002401 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002402 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002403 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002404 VkExtent3D granularity = GetScaledItg(cb_node, img);
2405 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002406 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002407 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002408 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002409 return skip;
2410}
2411
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002412// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002413bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002414 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002415 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002416 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002417 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002418 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2419 skip |=
2420 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002421 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002422 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002423 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2424 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002425
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002426 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002427 granularity = GetScaledItg(cb_node, dst_img);
2428 skip |=
2429 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002430 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002431 const VkExtent3D dest_effective_extent =
2432 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002433 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002434 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002435 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002436 return skip;
2437}
2438
Dave Houlton6f9059e2017-05-02 17:15:13 -06002439// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002440bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002441 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002442 bool skip = false;
2443
2444 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002445 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002446
2447 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002448 const VkExtent3D src_copy_extent = region.extent;
2449 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002450 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2451
Dave Houlton6f9059e2017-05-02 17:15:13 -06002452 bool slice_override = false;
2453 uint32_t depth_slices = 0;
2454
2455 // Special case for copying between a 1D/2D array and a 3D image
2456 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2457 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002458 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002459 slice_override = (depth_slices != 1);
2460 } 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 -07002461 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002462 slice_override = (depth_slices != 1);
2463 }
2464
2465 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002466 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002467 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002468 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002469 LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-00146",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002470 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2471 "be 0 and 1, respectively.",
2472 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002473 }
2474 }
2475
Dave Houlton533be9f2018-03-26 17:08:30 -06002476 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002477 skip |= LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-01785",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002478 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2479 "these must be 0 and 1, respectively.",
2480 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002481 }
2482
Dave Houlton533be9f2018-03-26 17:08:30 -06002483 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002484 skip |= LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-01787",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002485 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2486 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002487 }
2488
Dave Houltonc991cc92018-03-06 11:08:51 -07002489 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002490 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002491 if (FormatIsCompressed(src_state->createInfo.format) ||
2492 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002493 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002494 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002495 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2496 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2497 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002498 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002499 skip |= LogError(src_state->image, vuid,
2500 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2501 "texel width & height (%d, %d).",
2502 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002503 }
2504
Dave Houlton94a00372017-12-14 15:08:47 -07002505 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002506 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2507 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002508 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002509 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002510 LogError(src_state->image, vuid,
2511 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2512 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2513 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002514 }
2515
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002516 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002517 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2518 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002519 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002520 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002521 LogError(src_state->image, vuid,
2522 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2523 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2524 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002525 }
2526
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002527 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002528 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2529 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002530 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002531 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002532 LogError(src_state->image, vuid,
2533 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2534 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2535 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002536 }
2537 } // Compressed
2538
2539 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002540 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002541 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002542 skip |= LogError(dst_state->image, "VUID-vkCmdCopyImage-dstImage-00152",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002543 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2544 "these must be 0 and 1, respectively.",
2545 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002546 }
2547 }
2548
Dave Houlton533be9f2018-03-26 17:08:30 -06002549 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 -07002550 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002551 LogError(dst_state->image, "VUID-vkCmdCopyImage-dstImage-01786",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002552 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2553 "and 1, respectively.",
2554 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002555 }
2556
Dave Houlton533be9f2018-03-26 17:08:30 -06002557 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002558 skip |= LogError(dst_state->image, "VUID-vkCmdCopyImage-dstImage-01788",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002559 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2560 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002561 }
2562
sfricke-samsung30b094c2020-05-30 11:42:11 -07002563 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002564 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002565 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2566 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
2567 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002568 LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-04443",
sfricke-samsung30b094c2020-05-30 11:42:11 -07002569 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2570 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2571 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2572 }
2573 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002574 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002575 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002576 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002577 LogError(dst_state->image, "VUID-vkCmdCopyImage-dstImage-04444",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002578 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2579 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2580 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002581 }
2582 }
2583 } else { // Pre maint 1
2584 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002585 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002586 skip |= LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-00139",
sfricke-samsung30b094c2020-05-30 11:42:11 -07002587 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2588 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2589 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2590 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2591 }
Dave Houltonee281a52017-12-08 13:51:02 -07002592 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002593 skip |= LogError(dst_state->image, "VUID-vkCmdCopyImage-srcImage-00139",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002594 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2595 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2596 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2597 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002598 }
2599 }
2600 }
2601
Dave Houltonc991cc92018-03-06 11:08:51 -07002602 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2603 if (FormatIsCompressed(dst_state->createInfo.format) ||
2604 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002605 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002606
2607 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002608 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2609 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2610 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002611 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002612 skip |= LogError(dst_state->image, vuid,
2613 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2614 "texel width & height (%d, %d).",
2615 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002616 }
2617
Dave Houlton94a00372017-12-14 15:08:47 -07002618 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002619 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2620 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002621 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002622 skip |= LogError(
2623 dst_state->image, vuid,
2624 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2625 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2626 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002627 }
2628
Dave Houltonee281a52017-12-08 13:51:02 -07002629 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2630 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2631 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002632 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002633 skip |= LogError(dst_state->image, vuid,
2634 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2635 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2636 "height (%d).",
2637 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002638 }
2639
Dave Houltonee281a52017-12-08 13:51:02 -07002640 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2641 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2642 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002643 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002644 skip |= LogError(
2645 dst_state->image, vuid,
2646 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2647 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2648 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002649 }
2650 } // Compressed
2651 }
2652 return skip;
2653}
2654
Dave Houltonc991cc92018-03-06 11:08:51 -07002655// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002656bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002657 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002658 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002659
2660 // Neither image is multiplane
2661 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2662 // If neither image is multi-plane the aspectMask member of src and dst must match
2663 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2664 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002665 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002666 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002667 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002668 }
2669 } else {
2670 // Source image multiplane checks
2671 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2672 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2673 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2674 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002675 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002676 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002677 }
2678 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2679 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2680 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002681 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002682 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002683 }
2684 // Single-plane to multi-plane
2685 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2686 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2687 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002688 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002689 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002690 }
2691
2692 // Dest image multiplane checks
2693 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2694 aspect = region.dstSubresource.aspectMask;
2695 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2696 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002697 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002698 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002699 }
2700 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2701 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2702 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002703 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002704 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002705 }
2706 // Multi-plane to single-plane
2707 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2708 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2709 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002710 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002711 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002712 }
2713 }
2714
2715 return skip;
2716}
2717
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002718bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2719 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002720 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002721 const auto *cb_node = GetCBState(commandBuffer);
2722 const auto *src_image_state = GetImageState(srcImage);
2723 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002724 const VkFormat src_format = src_image_state->createInfo.format;
2725 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002726 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002727
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002728 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002729
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002730 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2731
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002732 for (uint32_t i = 0; i < regionCount; i++) {
2733 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002734
2735 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2736 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002737 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002738
Dave Houlton6f9059e2017-05-02 17:15:13 -06002739 bool slice_override = false;
2740 uint32_t depth_slices = 0;
2741
2742 // Special case for copying between a 1D/2D array and a 3D image
2743 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2744 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2745 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002746 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002747 slice_override = (depth_slices != 1);
2748 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2749 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002750 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002751 slice_override = (depth_slices != 1);
2752 }
2753
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002754 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2755 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2756 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002757 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002758 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002759 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002760 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002761 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2762 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002763 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002764 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2765 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002766
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002767 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002768 // No chance of mismatch if we're overriding depth slice count
2769 if (!slice_override) {
2770 // The number of depth slices in srcSubresource and dstSubresource must match
2771 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2772 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002773 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2774 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002775 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002776 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2777 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002778 if (src_slices != dst_slices) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002779 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140",
2780 "vkCmdCopyImage(): number of depth slices in source and destination subresources for "
2781 "pRegions[%u] do not match.",
2782 i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002783 }
2784 }
2785 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002786 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002787 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002788 skip |= LogError(
2789 command_buffer, "VUID-VkImageCopy-layerCount-00138",
2790 "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[%u] do not match", i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002791 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002792 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002793
Dave Houltonc991cc92018-03-06 11:08:51 -07002794 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002795 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002796 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002797 }
2798
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002799 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002800 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2801 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002802 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002803 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002804 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002805 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002806
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002807 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002808 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002809 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002810 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002811 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002812 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002813 }
2814
2815 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002816 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002817 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002818 ss << "vkCmdCopyImage(): pRegion[" << i
2819 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002820 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002821 }
2822
Dave Houltonfc1a4052017-04-27 14:32:45 -06002823 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002824 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2825 if (slice_override) src_copy_extent.depth = depth_slices;
2826 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002827 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002828 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002829 LogError(command_buffer, "VUID-vkCmdCopyImage-srcOffset-00144",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002830 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2831 "width [%1d].",
2832 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002833 }
2834
2835 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002836 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002837 LogError(command_buffer, "VUID-vkCmdCopyImage-srcOffset-00145",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002838 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2839 "height [%1d].",
2840 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002841 }
2842 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002843 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002844 LogError(command_buffer, "VUID-vkCmdCopyImage-srcOffset-00147",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002845 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2846 "depth [%1d].",
2847 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002848 }
2849
Dave Houltonee281a52017-12-08 13:51:02 -07002850 // Adjust dest extent if necessary
2851 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2852 if (slice_override) dst_copy_extent.depth = depth_slices;
2853
2854 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002855 if (extent_check & x_bit) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002856 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstOffset-00150",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002857 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2858 "width [%1d].",
2859 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002860 }
2861 if (extent_check & y_bit) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002862 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstOffset-00151",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002863 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2864 "height [%1d].",
2865 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002866 }
2867 if (extent_check & z_bit) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002868 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstOffset-00153",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002869 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2870 "depth [%1d].",
2871 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002872 }
2873
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002874 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2875 // must not overlap in memory
2876 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002877 for (uint32_t j = 0; j < regionCount; j++) {
2878 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002879 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002880 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002881 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002882 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002883 }
2884 }
2885 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002886
2887 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2888 if (device_extensions.vk_khr_maintenance1) {
2889 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2890 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2891 (src_copy_extent.depth != 1)) {
2892 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002893 command_buffer, "VUID-vkCmdCopyImage-srcImage-01790",
sfricke-samsung48172ca2020-02-13 23:38:11 -08002894 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2895 src_copy_extent.depth);
2896 }
2897 } else {
2898 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2899 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2900 (src_copy_extent.depth != 1)) {
2901 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002902 command_buffer, "VUID-vkCmdCopyImage-srcImage-01789",
sfricke-samsung48172ca2020-02-13 23:38:11 -08002903 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2904 src_copy_extent.depth);
2905 }
2906 }
2907
2908 // Check if 2D with 3D and depth not equal to 2D layerCount
2909 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2910 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2911 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002912 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01791",
sfricke-samsung48172ca2020-02-13 23:38:11 -08002913 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2914 "srcSubresource.layerCount (%u)",
2915 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2916 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2917 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2918 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002919 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstImage-01792",
sfricke-samsung48172ca2020-02-13 23:38:11 -08002920 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2921 "dstSubresource.layerCount (%u)",
2922 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2923 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002924
2925 // Check for multi-plane format compatiblity
2926 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
2927 size_t src_format_size = 0;
2928 size_t dst_format_size = 0;
2929 if (FormatIsMultiplane(src_format)) {
2930 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
2931 src_format_size = FormatElementSize(planeFormat);
2932 } else {
2933 src_format_size = FormatElementSize(src_format);
2934 }
2935 if (FormatIsMultiplane(dst_format)) {
2936 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
2937 dst_format_size = FormatElementSize(planeFormat);
2938 } else {
2939 dst_format_size = FormatElementSize(dst_format);
2940 }
2941 // If size is still zero, then format is invalid and will be caught in another VU
2942 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
2943 skip |=
2944 LogError(command_buffer, "VUID-vkCmdCopyImage-None-01549",
2945 "vkCmdCopyImage(): pRegions[%u] called with non-compatible image formats. "
2946 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
2947 i, string_VkFormat(src_format), string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(),
2948 string_VkFormat(dst_format), string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
2949 }
2950 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002951 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002952
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002953 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
2954 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
2955 // because because both texels are 4 bytes in size.
2956 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
2957 const char *compatible_vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2958 : "VUID-vkCmdCopyImage-srcImage-00135";
2959 // Depth/stencil formats must match exactly.
2960 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2961 if (src_format != dst_format) {
2962 skip |= LogError(command_buffer, compatible_vuid,
2963 "vkCmdCopyImage(): Depth/stencil formats must match exactly for src (%s) and dst (%s).",
2964 string_VkFormat(src_format), string_VkFormat(dst_format));
2965 }
2966 } else {
2967 if (!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) {
2968 skip |= LogError(command_buffer, compatible_vuid,
2969 "vkCmdCopyImage(): Unmatched image format sizes. "
2970 "The src format %s has size of %zu and dst format %s has size of %zu.",
2971 string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
2972 FormatElementSize(dst_format));
2973 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002974 }
2975 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002976
Dave Houlton33c22b72017-02-28 13:16:02 -07002977 // Source and dest image sample counts must match
2978 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2979 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002980 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002981 }
2982
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002983 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2984 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002985 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002986 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2987 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2988 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2989 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
sfricke-samsung022fa252020-07-24 03:26:16 -07002990 skip |= ValidateProtectedImage(cb_node, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-commandBuffer-01825");
2991 skip |= ValidateProtectedImage(cb_node, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-commandBuffer-01826");
2992 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-commandBuffer-01827");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02002993
2994 // Validation for VK_EXT_fragment_density_map
2995 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
2996 skip |= LogError(
2997 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
2998 "vkCmdCopyImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
2999 }
3000 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3001 skip |= LogError(
3002 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
3003 "vkCmdCopyImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3004 }
3005
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003006 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003007 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003008 "VUID-vkCmdCopyImage-srcImage-01995");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003009 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003010 "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04003011 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003012 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003013 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003014 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
3015 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06003016 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003017 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3018 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
3019 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
3020 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3021 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
3022 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003023 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003024 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003025 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
3026 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003027 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003028 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
3029 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003030 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
3031 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003032 }
3033
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003034 return skip;
3035}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003036
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003037void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3038 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3039 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003040 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3041 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003042 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003043 auto src_image_state = GetImageState(srcImage);
3044 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003045
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003046 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003047 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003048 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3049 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003050 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003051}
3052
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003053// Returns true if sub_rect is entirely contained within rect
3054static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3055 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
3056 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
3057 return false;
3058 return true;
3059}
3060
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003061bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003062 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
3063 const VkRect2D &render_area, uint32_t rect_count,
3064 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003065 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003066 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3067 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06003068 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07003069 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003070
3071 for (uint32_t j = 0; j < rect_count; j++) {
3072 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003073 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3074 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3075 "the current render pass instance.",
3076 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003077 }
3078
3079 if (image_view_state) {
3080 // The layers specified by a given element of pRects must be contained within every attachment that
3081 // pAttachments refers to
3082 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3083 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3084 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003085 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3086 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3087 "of pAttachment[%d].",
3088 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003089 }
3090 }
3091 }
3092 return skip;
3093}
3094
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003095bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3096 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003097 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003098 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003099 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003100 if (!cb_node) return skip;
3101
3102 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3103 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3104 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003105 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003106
3107 // Validate that attachment is in reference list of active subpass
3108 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003109 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003110 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003111 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003112 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003113 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003114
John Zulauf3a548ef2019-02-01 16:14:07 -07003115 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3116 auto clear_desc = &pAttachments[attachment_index];
3117 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003118
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003119 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003120 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003121 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003122 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003123 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003124 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3125 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3126 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3127 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003128 skip |= LogError(
3129 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3130 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3131 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3132 attachment_index, clear_desc->colorAttachment,
3133 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3134 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003135
John Zulauff2582972019-02-09 14:53:30 -07003136 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3137 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003138 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003139 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3140 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3141 " subpass %u. colorAttachmentCount=%u",
3142 attachment_index, clear_desc->colorAttachment,
3143 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3144 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003145 }
John Zulauff2582972019-02-09 14:53:30 -07003146 fb_attachment = color_attachment;
3147
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003148 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3149 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3150 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003151 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003152 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003153 }
3154 } else { // Must be depth and/or stencil
3155 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
3156 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003157 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003158 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003159 }
3160 if (!subpass_desc->pDepthStencilAttachment ||
3161 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003162 skip |= LogPerformanceWarning(
3163 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003164 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003165 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003166 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003167 }
3168 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003169 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003170 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3171 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003172 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003173
3174 // Once the framebuffer attachment is found, can get the image view state
3175 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3176 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3177 const IMAGE_VIEW_STATE *image_view_state =
3178 GetAttachmentImageViewState(GetCBState(commandBuffer), framebuffer, fb_attachment);
3179 if (image_view_state != nullptr) {
3180 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3181 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3182 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3183 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3184 }
3185 }
John Zulauf441558b2019-08-12 11:47:39 -06003186 }
3187 }
3188 return skip;
3189}
3190
3191void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3192 const VkClearAttachment *pAttachments, uint32_t rectCount,
3193 const VkClearRect *pRects) {
3194 auto *cb_node = GetCBState(commandBuffer);
3195 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3196 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3197 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3198 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3199 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3200 const auto clear_desc = &pAttachments[attachment_index];
3201 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3202 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3203 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3204 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3205 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3206 subpass_desc->pDepthStencilAttachment) {
3207 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3208 }
3209 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003210 if (!clear_rect_copy) {
3211 // We need a copy of the clear rectangles that will persist until the last lambda executes
3212 // but we want to create it as lazily as possible
3213 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003214 }
John Zulauf441558b2019-08-12 11:47:39 -06003215 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3216 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003217 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003218 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003219 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003220 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3221 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003222 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
3223 clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003224 return skip;
3225 };
3226 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003227 }
3228 }
3229 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003230}
3231
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003232bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3233 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003234 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003235 const auto *cb_node = GetCBState(commandBuffer);
3236 const auto *src_image_state = GetImageState(srcImage);
3237 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003238
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003239 bool skip = false;
3240 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003241 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3242 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003243 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003244 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003245 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3246 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003247 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003248 "VUID-vkCmdResolveImage-dstImage-02003");
sfricke-samsung022fa252020-07-24 03:26:16 -07003249 skip |=
3250 ValidateProtectedImage(cb_node, src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-commandBuffer-01837");
3251 skip |=
3252 ValidateProtectedImage(cb_node, dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-commandBuffer-01838");
3253 skip |=
3254 ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-commandBuffer-01839");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003255
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003256 // Validation for VK_EXT_fragment_density_map
3257 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3258 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3259 "vkCmdResolveImage(): srcImage must not have been created with flags containing "
3260 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3261 }
3262 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3263 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3264 "vkCmdResolveImage(): dstImage must not have been created with flags containing "
3265 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3266 }
3267
Cort Stratton7df30962018-05-17 19:45:57 -07003268 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003269 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003270 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003271 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3272 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3273 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003274 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003275 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3276 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003277 // For each region, the number of layers in the image subresource should not be zero
3278 // For each region, src and dest image aspect must be color only
3279 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003280 const VkImageResolve region = pRegions[i];
3281 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3282 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003283 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, "vkCmdResolveImage()", "srcSubresource", i);
3284 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, "vkCmdResolveImage()", "dstSubresource", i);
3285 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003286 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3287 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003288 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003289 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3290 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003291 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003292 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003293 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003294 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003295 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
3296 src_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003297 "VUID-vkCmdResolveImage-srcSubresource-01711");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003298 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
3299 dst_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003300 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003301
3302 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003303 if (src_subresource.layerCount != dst_subresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003304 skip |= LogError(
3305 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003306 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%u] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003307 }
Cort Stratton7df30962018-05-17 19:45:57 -07003308 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003309 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3310 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3311 skip |= LogError(
3312 cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266",
3313 "vkCmdResolveImage(): src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3314 i);
3315 }
3316
3317 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3318 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3319
3320 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003321 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003322 LogObjectList objlist(cb_node->commandBuffer);
3323 objlist.add(src_image_state->image);
3324 objlist.add(dst_image_state->image);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003325 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcImage-04446",
3326 "vkCmdResolveImage(): pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
3327 "subresources if the src or dst image is 3D.",
3328 i);
3329 }
3330 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3331 LogObjectList objlist(cb_node->commandBuffer);
3332 objlist.add(src_image_state->image);
3333 objlist.add(dst_image_state->image);
3334 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcImage-04447",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003335 "vkCmdResolveImage(): pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
3336 "subresources if the src or dst image is 3D.",
3337 i);
3338 }
3339 }
3340
3341 if (VK_IMAGE_TYPE_1D == src_image_type) {
3342 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3343 LogObjectList objlist(cb_node->commandBuffer);
3344 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003345 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcImage-00271",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003346 "vkCmdResolveImage(): srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
3347 "extent.height (%u) is not 1.",
3348 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.y,
3349 pRegions[i].extent.height);
3350 }
3351 }
3352 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3353 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3354 LogObjectList objlist(cb_node->commandBuffer);
3355 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003356 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcImage-00273",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003357 "vkCmdResolveImage(): srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
3358 "extent.depth (%u) is not 1.",
3359 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.z,
3360 pRegions[i].extent.depth);
3361 }
3362 }
3363
3364 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3365 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3366 LogObjectList objlist(cb_node->commandBuffer);
3367 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003368 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstImage-00276",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003369 "vkCmdResolveImage(): dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
3370 "extent.height (%u) is not 1.",
3371 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.y,
3372 pRegions[i].extent.height);
3373 }
3374 }
3375 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3376 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3377 LogObjectList objlist(cb_node->commandBuffer);
3378 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003379 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstImage-00278",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003380 "vkCmdResolveImage(): dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
3381 "extent.depth (%u) is not 1.",
3382 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.z,
3383 pRegions[i].extent.depth);
3384 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003385 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003386
3387 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3388 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3389 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3390 // developer
3391 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3392 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
3393 if ((extent_check & x_bit) != 0) {
3394 LogObjectList objlist(cb_node->commandBuffer);
3395 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003396 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcOffset-00269",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003397 "vkCmdResolveImage(): srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
3398 "exceeds subResource width [%u].",
3399 report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
3400 region.extent.width, subresource_extent.width);
3401 }
3402
3403 if ((extent_check & y_bit) != 0) {
3404 LogObjectList objlist(cb_node->commandBuffer);
3405 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003406 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcOffset-00270",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003407 "vkCmdResolveImage(): srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
3408 "exceeds subResource height [%u].",
3409 report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
3410 region.extent.height, subresource_extent.height);
3411 }
3412
3413 if ((extent_check & z_bit) != 0) {
3414 LogObjectList objlist(cb_node->commandBuffer);
3415 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003416 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcOffset-00272",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003417 "vkCmdResolveImage(): srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
3418 "exceeds subResource depth [%u].",
3419 report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
3420 region.extent.depth, subresource_extent.depth);
3421 }
3422 }
3423
3424 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3425 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3426 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3427 // developer
3428 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3429 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
3430 if ((extent_check & x_bit) != 0) {
3431 LogObjectList objlist(cb_node->commandBuffer);
3432 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003433 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstOffset-00274",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003434 "vkCmdResolveImage(): dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
3435 "exceeds subResource width [%u].",
3436 report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
3437 region.extent.width, subresource_extent.width);
3438 }
3439
3440 if ((extent_check & y_bit) != 0) {
3441 LogObjectList objlist(cb_node->commandBuffer);
3442 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003443 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstOffset-00275",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003444 "vkCmdResolveImage(): dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
3445 "exceeds subResource height [%u].",
3446 report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
3447 region.extent.height, subresource_extent.height);
3448 }
3449
3450 if ((extent_check & z_bit) != 0) {
3451 LogObjectList objlist(cb_node->commandBuffer);
3452 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003453 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstOffset-00277",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003454 "vkCmdResolveImage(): dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
3455 "exceeds subResource depth [%u].",
3456 report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
3457 region.extent.depth, subresource_extent.depth);
3458 }
3459 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003460 }
3461
3462 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003463 skip |=
3464 LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-01386",
3465 "vkCmdResolveImage(): srcImage format (%s) and dstImage format (%s) are not the same.",
3466 string_VkFormat(src_image_state->createInfo.format), string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003467 }
3468 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003469 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
3470 "vkCmdResolveImage(): srcImage type (%s) and dstImage type (%s) are not the same.",
3471 string_VkImageType(src_image_state->createInfo.imageType),
3472 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003473 }
3474 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003475 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257",
3476 "vkCmdResolveImage(): srcImage sample count is VK_SAMPLE_COUNT_1_BIT.");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003477 }
3478 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003479 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259",
3480 "vkCmdResolveImage(): dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3481 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003482 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003483 } else {
3484 assert(0);
3485 }
3486 return skip;
3487}
3488
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003489bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3490 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003491 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003492 const auto *cb_node = GetCBState(commandBuffer);
3493 const auto *src_image_state = GetImageState(srcImage);
3494 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003495
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003496 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003497 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003498 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003499 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003500 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003501 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003502 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003503 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003504 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003505 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3506 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003507 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003508 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3509 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003510 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003511 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3512 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003513 skip |=
3514 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003515 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3516 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003517 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003518 "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003519 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003520 "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003521
sfricke-samsung022fa252020-07-24 03:26:16 -07003522 skip |= ValidateProtectedImage(cb_node, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-commandBuffer-01834");
3523 skip |= ValidateProtectedImage(cb_node, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-commandBuffer-01835");
3524 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-commandBuffer-01836");
3525
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003526 // Validation for VK_EXT_fragment_density_map
3527 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3528 skip |= LogError(
3529 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3530 "vkCmdBlitImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3531 }
3532 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3533 skip |= LogError(
3534 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3535 "vkCmdBlitImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3536 }
3537
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003538 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003539
Dave Houlton33c2d252017-06-09 17:08:32 -06003540 VkFormat src_format = src_image_state->createInfo.format;
3541 VkFormat dst_format = dst_image_state->createInfo.format;
3542 VkImageType src_type = src_image_state->createInfo.imageType;
3543 VkImageType dst_type = dst_image_state->createInfo.imageType;
3544
Cort Stratton186b1a22018-05-01 20:18:06 -04003545 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003546 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003547 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003548 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003549 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003550 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003551 }
3552
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003553 if (FormatRequiresYcbcrConversion(src_format)) {
3554 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3555 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3556 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3557 string_VkFormat(src_format));
3558 }
3559
3560 if (FormatRequiresYcbcrConversion(dst_format)) {
3561 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3562 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3563 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3564 string_VkFormat(dst_format));
3565 }
3566
Dave Houlton33c2d252017-06-09 17:08:32 -06003567 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003568 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3569 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003570 }
3571
Dave Houlton33c2d252017-06-09 17:08:32 -06003572 // Validate consistency for unsigned formats
3573 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3574 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003575 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003576 << "the other one must also have unsigned integer format. "
3577 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003578 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003579 }
3580
3581 // Validate consistency for signed formats
3582 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3583 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003584 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003585 << "the other one must also have signed integer format. "
3586 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003587 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003588 }
3589
3590 // Validate filter for Depth/Stencil formats
3591 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3592 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003593 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003594 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003595 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003596 }
3597
3598 // Validate aspect bits and formats for depth/stencil images
3599 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3600 if (src_format != dst_format) {
3601 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003602 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003603 << "stencil, the other one must have exactly the same format. "
3604 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3605 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003606 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003607 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003608 } // Depth or Stencil
3609
3610 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003611 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003612 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003613 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3614 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3615 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003616 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003617 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3618 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003619 for (uint32_t i = 0; i < regionCount; i++) {
3620 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003621 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003622 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003623 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3624 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003625 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003626 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3627 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003628 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3629 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3630 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003631 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003632 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003633 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003634 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003635 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3636 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003637 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003638 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3639 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003640 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003641 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3642 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003643 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003644 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003645 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003646 }
Dave Houlton48989f32017-05-26 15:01:46 -06003647 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3648 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003649 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003650 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003651 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003652 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003653
3654 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003655 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003656 skip |= LogError(
3657 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003658 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003659 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003660
Dave Houlton48989f32017-05-26 15:01:46 -06003661 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003662 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3663 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003664 }
Dave Houlton48989f32017-05-26 15:01:46 -06003665
Dave Houlton33c2d252017-06-09 17:08:32 -06003666 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003667 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-aspectMask-00241",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003668 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3669 "image format %s.",
3670 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003671 }
3672
3673 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003674 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003675 cb_node->commandBuffer, "VUID-vkCmdBlitImage-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003676 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3677 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003678 }
3679
Dave Houlton48989f32017-05-26 15:01:46 -06003680 // Validate source image offsets
3681 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003682 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003683 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003684 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003685 LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00245",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003686 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3687 "of (%1d, %1d). These must be (0, 1).",
3688 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003689 }
3690 }
3691
Dave Houlton33c2d252017-06-09 17:08:32 -06003692 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003693 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003694 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003695 LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00247",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003696 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3697 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3698 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003699 }
3700 }
3701
Dave Houlton33c2d252017-06-09 17:08:32 -06003702 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003703 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3704 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003705 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003706 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003707 cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003708 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3709 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003710 }
3711 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3712 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003713 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003714 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003715 cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003716 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003717 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003718 }
3719 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3720 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003721 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003722 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003723 cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003724 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3725 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003726 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003727 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003728 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3729 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003730 }
Dave Houlton48989f32017-05-26 15:01:46 -06003731
3732 // Validate dest image offsets
3733 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003734 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003735 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003736 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003737 LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-00250",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003738 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3739 "(%1d, %1d). These must be (0, 1).",
3740 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003741 }
3742 }
3743
Dave Houlton33c2d252017-06-09 17:08:32 -06003744 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003745 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003746 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-00252",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003747 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3748 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3749 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003750 }
3751 }
3752
Dave Houlton33c2d252017-06-09 17:08:32 -06003753 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003754 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3755 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003756 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003757 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003758 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003759 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3760 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003761 }
3762 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3763 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003764 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003765 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003766 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003767 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003768 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003769 }
3770 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3771 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003772 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003773 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003774 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003775 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3776 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003777 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003778 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003779 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3780 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003781 }
3782
Dave Houlton33c2d252017-06-09 17:08:32 -06003783 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3784 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3785 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003786 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003787 LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00240",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003788 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3789 "layerCount other than 1.",
3790 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003791 }
3792 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003793 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003794 } else {
3795 assert(0);
3796 }
3797 return skip;
3798}
3799
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003800void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3801 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3802 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003803 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3804 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003805 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003806 auto src_image_state = GetImageState(srcImage);
3807 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003808
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003809 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003810 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003811 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3812 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003813 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003814}
3815
John Zulauf2076e812020-01-08 14:55:54 -07003816GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3817 assert(map);
3818 // This approach allows for a single hash lookup or/create new
3819 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3820 if (inserted.second) {
3821 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06003822 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07003823 inserted.first->second.reset(layout_map);
3824 return layout_map;
3825 } else {
3826 assert(nullptr != inserted.first->second.get());
3827 return inserted.first->second.get();
3828 }
3829 return nullptr;
3830}
3831
3832const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3833 auto it = map.find(image);
3834 if (it != map.end()) {
3835 return it->second.get();
3836 }
3837 return nullptr;
3838}
3839
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003840// 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 -07003841bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3842 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06003843 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003844 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003845 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003846 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003847 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003848 for (const auto &layout_map_entry : pCB->image_layout_map) {
3849 const auto image = layout_map_entry.first;
3850 const auto *image_state = GetImageState(image);
3851 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003852 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003853 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003854 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003855 if (initial_layout_map.empty()) continue;
3856
3857 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3858 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3859 if (global_map == nullptr) {
3860 global_map = &empty_map;
3861 }
3862
3863 // Note: don't know if it would matter
3864 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3865
3866 auto pos = initial_layout_map.begin();
3867 const auto end = initial_layout_map.end();
3868 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3869 pos->first.begin);
3870 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003871 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003872 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003873 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 -07003874 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003875 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003876 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003877 image_layout = current_layout->pos_B->lower_bound->second;
3878 }
3879 const auto intersected_range = pos->first & current_layout->range;
3880 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3881 // TODO: Set memory invalid which is in mem_tracker currently
3882 } else if (image_layout != initial_layout) {
3883 // Need to look up the inital layout *state* to get a bit more information
3884 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3885 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3886 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3887 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07003888 // We can report all the errors for the intersected range directly
3889 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06003890 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003891 skip |= LogError(
3892 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003893 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003894 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07003895 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003896 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06003897 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003898 }
3899 }
John Zulauf2076e812020-01-08 14:55:54 -07003900 if (pos->first.includes(intersected_range.end)) {
3901 current_layout.seek(intersected_range.end);
3902 } else {
3903 ++pos;
3904 if (pos != end) {
3905 current_layout.seek(pos->first.begin);
3906 }
3907 }
John Zulauff660ad62019-03-23 07:16:05 -06003908 }
3909
locke-lunargf155ccf2020-02-18 11:34:15 -07003910 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003911 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003912 }
John Zulauff660ad62019-03-23 07:16:05 -06003913
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003914 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003915}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003916
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003917void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003918 for (const auto &layout_map_entry : pCB->image_layout_map) {
3919 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003920 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003921 const auto *image_state = GetImageState(image);
3922 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003923 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3924 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003925 }
3926}
3927
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003928// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003929// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3930// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003931bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3932 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003933 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003934 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003935 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3936
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003937 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07003938 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
3939 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003940 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003941 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3942 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3943 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003944 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003945 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003946 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07003947 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3948 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
3949 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003950 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003951 string_VkImageLayout(first_layout));
3952 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3953 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003954 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003955 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003956 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003957 }
3958 }
sfricke-samsung55f01952020-03-24 08:16:41 -07003959
3960 // Same as above for loadOp, but for stencilLoadOp
3961 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3962 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3963 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3964 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
3965 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003966 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003967 string_VkImageLayout(first_layout));
3968 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3969 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
3970 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003971 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003972 string_VkImageLayout(first_layout));
3973 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3974 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3975 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003976 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003977 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003978 }
3979 }
3980
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003981 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003982}
3983
Mark Lobodzinski96210742017-02-09 10:33:46 -07003984// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3985// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003986template <typename T1>
3987bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
3988 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
3989 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003990 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003991 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003992 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003993 if (strict) {
3994 correct_usage = ((actual & desired) == desired);
3995 } else {
3996 correct_usage = ((actual & desired) != 0);
3997 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003998
Mark Lobodzinski96210742017-02-09 10:33:46 -07003999 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004000 // All callers should have a valid VUID
4001 assert(msgCode != kVUIDUndefined);
4002 skip =
4003 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4004 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004005 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004006 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004007}
4008
4009// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4010// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004011bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004012 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004013 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004014 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004015}
4016
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004017bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004018 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004019 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004020 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4021 if ((image_format_features & desired) != desired) {
4022 // Same error, but more details if it was an AHB external format
4023 if (image_state->has_ahb_format == true) {
4024 skip |= LogError(image_state->image, vuid,
4025 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4026 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4027 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004028 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004029 } else {
4030 skip |= LogError(image_state->image, vuid,
4031 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4032 "with tiling %s.",
4033 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4034 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4035 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004036 }
4037 }
4038 return skip;
4039}
4040
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004041bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004042 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004043 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004044 // layerCount must not be zero
4045 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004046 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4047 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004048 }
4049 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4050 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004051 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4052 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004053 }
4054 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4055 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4056 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004057 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4058 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4059 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4060 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004061 }
4062 return skip;
4063}
4064
Mark Lobodzinski96210742017-02-09 10:33:46 -07004065// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4066// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004067bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004068 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004069 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004070 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004071}
4072
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004073bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004074 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004075 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004076
4077 const VkDeviceSize &range = pCreateInfo->range;
4078 if (range != VK_WHOLE_SIZE) {
4079 // Range must be greater than 0
4080 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004081 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004082 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004083 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4084 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004085 }
4086 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004087 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4088 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004089 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004090 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004091 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4092 "(%" PRIu32 ").",
4093 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004094 }
4095 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004096 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004097 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004098 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004099 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4100 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4101 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004102 }
4103 // The sum of range and offset must be less than or equal to the size of buffer
4104 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004105 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004106 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004107 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4108 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4109 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004110 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004111 } else {
4112 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4113
4114 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4115 // VkPhysicalDeviceLimits::maxTexelBufferElements
4116 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4117 device_limits->maxTexelBufferElements) {
4118 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4119 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4120 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4121 "), divided by the element size of the format (%" PRIu32
4122 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4123 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4124 device_limits->maxTexelBufferElements);
4125 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004126 }
4127 return skip;
4128}
4129
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004130bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004131 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004132 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004133 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4134 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004135 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004136 "vkCreateBufferView(): If buffer was created with `usage` containing "
4137 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004138 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004139 }
4140 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4141 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004142 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004143 "vkCreateBufferView(): If buffer was created with `usage` containing "
4144 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004145 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004146 }
4147 return skip;
4148}
4149
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004150bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004151 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004152 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004153
Dave Houltond8ed0212018-05-16 17:18:24 -06004154 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004155
Jeff Bolz87697532019-01-11 22:54:00 -06004156 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4157 if (chained_devaddr_struct) {
4158 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4159 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004160 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4161 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4162 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004163 }
4164 }
4165
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004166 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4167 if (chained_opaqueaddr_struct) {
4168 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4169 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004170 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4171 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4172 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004173 }
4174 }
4175
Shannon McPherson4984e642019-12-05 13:04:34 -07004176 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004177 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4178 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004179 skip |= LogError(
4180 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004181 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4182 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4183 }
4184
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004185 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004186 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4187 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4188 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004189 }
4190
sfricke-samsungedce77a2020-07-03 22:35:13 -07004191 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4192 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4193 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4194 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4195 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4196 }
4197 const VkBufferCreateFlags invalid_flags =
4198 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4199 if ((pCreateInfo->flags & invalid_flags) != 0) {
4200 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4201 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4202 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4203 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4204 }
4205 }
4206
Mark Lobodzinski96210742017-02-09 10:33:46 -07004207 return skip;
4208}
4209
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004210bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004211 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004212 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004213 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004214 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4215 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004216 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004217 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4218 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004219 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004220 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4221 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4222 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004223
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004224 // Buffer view offset must be less than the size of buffer
4225 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004226 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004227 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004228 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4229 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004230 }
4231
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004232 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004233 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4234 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4235 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004236 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4237 : "VUID-VkBufferViewCreateInfo-offset-00926";
4238 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004239 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004240 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4241 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004242 }
4243
4244 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4245 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4246 if ((elementSize % 3) == 0) {
4247 elementSize /= 3;
4248 }
4249 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4250 VkDeviceSize alignmentRequirement =
4251 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4252 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4253 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4254 }
4255 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004256 skip |= LogError(
4257 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004258 "vkCreateBufferView(): If buffer was created with usage containing "
4259 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004260 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4261 ") must be a multiple of the lesser of "
4262 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4263 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4264 "(%" PRId32
4265 ") is VK_TRUE, the size of a texel of the requested format. "
4266 "If the size of a texel is a multiple of three bytes, then the size of a "
4267 "single component of format is used instead",
4268 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4269 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4270 }
4271 }
4272 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4273 VkDeviceSize alignmentRequirement =
4274 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4275 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4276 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4277 }
4278 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004279 skip |= LogError(
4280 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004281 "vkCreateBufferView(): If buffer was created with usage containing "
4282 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004283 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4284 ") must be a multiple of the lesser of "
4285 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4286 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4287 "(%" PRId32
4288 ") is VK_TRUE, the size of a texel of the requested format. "
4289 "If the size of a texel is a multiple of three bytes, then the size of a "
4290 "single component of format is used instead",
4291 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4292 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4293 }
4294 }
4295 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004296
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004297 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004298
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004299 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004300 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004301 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004302}
4303
Mark Lobodzinski602de982017-02-09 11:01:33 -07004304// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004305bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004306 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004307 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004308 const IMAGE_STATE *image_state = GetImageState(image);
4309 // checks color format and (single-plane or non-disjoint)
4310 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004311 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004312 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004313 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 -07004314 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004315 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 -07004316 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004317 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004318 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004319 skip |= LogError(image, vuid,
4320 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4321 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4322 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004323 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004324 skip |= LogError(image, vuid,
4325 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4326 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4327 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004328 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004329 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004330 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004331 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 -07004332 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004333 skip |=
4334 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 -07004335 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004336 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004337 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004338 skip |=
4339 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 -07004340 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004341 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4342 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004343 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004344 } else if (FormatIsMultiplane(format)) {
4345 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4346 if (3 == FormatPlaneCount(format)) {
4347 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4348 }
4349 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004350 skip |=
4351 LogError(image, vuid,
4352 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4353 "set, where n = [0, 1, 2].",
4354 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004355 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004356 }
4357 return skip;
4358}
4359
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004360bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4361 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004362 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4363 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004364 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004365
4366 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004367 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004368 skip |= LogError(image, errorCodes.base_mip_err,
4369 "%s: %s.baseMipLevel (= %" PRIu32
4370 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4371 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004372 }
Petr Kraus4d718682017-05-18 03:38:41 +02004373
Petr Krausffa94af2017-08-08 21:46:02 +02004374 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4375 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004376 skip |=
4377 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004378 } else {
4379 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004380
Petr Krausffa94af2017-08-08 21:46:02 +02004381 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004382 skip |= LogError(image, errorCodes.mip_count_err,
4383 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4384 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4385 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4386 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004387 }
Petr Kraus4d718682017-05-18 03:38:41 +02004388 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004389 }
Petr Kraus4d718682017-05-18 03:38:41 +02004390
4391 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004392 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004393 skip |= LogError(image, errorCodes.base_layer_err,
4394 "%s: %s.baseArrayLayer (= %" PRIu32
4395 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4396 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004397 }
Petr Kraus4d718682017-05-18 03:38:41 +02004398
Petr Krausffa94af2017-08-08 21:46:02 +02004399 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4400 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004401 skip |=
4402 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004403 } else {
4404 const uint64_t necessary_layer_count =
4405 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004406
Petr Krausffa94af2017-08-08 21:46:02 +02004407 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004408 skip |= LogError(image, errorCodes.layer_count_err,
4409 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4410 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4411 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4412 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004413 }
Petr Kraus4d718682017-05-18 03:38:41 +02004414 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004415 }
Petr Kraus4d718682017-05-18 03:38:41 +02004416
Mark Lobodzinski602de982017-02-09 11:01:33 -07004417 return skip;
4418}
4419
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004420bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004421 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004422 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004423 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4424 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4425 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4426
4427 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4428 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4429
4430 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004431 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4432 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004433 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004434 : "VUID-VkImageViewCreateInfo-image-01482")
4435 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4436 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004437 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004438 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4439 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004440
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004441 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004442 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004443 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004444}
4445
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004446bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004447 const VkImageSubresourceRange &subresourceRange,
4448 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004449 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004450 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4451 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4452 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4453 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004454
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004455 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004456 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004457 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004458}
4459
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004460bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004461 const VkImageSubresourceRange &subresourceRange,
4462 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004463 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004464 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4465 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4466 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4467 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004468
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004469 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004470 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4471 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004472}
4473
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004474bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004475 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004476 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004477 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004478 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4479 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4480 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4481 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004482
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004483 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004484 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004485}
4486
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004487bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4488 const VkImageUsageFlags image_usage) const {
4489 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4490 bool skip = false;
4491
4492 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4493 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4494
4495 if (image_state->has_ahb_format == true) {
4496 // AHB image view and image share same feature sets
4497 tiling_features = image_state->format_features;
4498 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4499 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4500 assert(device_extensions.vk_ext_image_drm_format_modifier);
4501 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4502 nullptr};
4503 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4504
4505 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4506 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4507 nullptr};
4508 format_properties_2.pNext = (void *)&drm_properties_list;
4509 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4510
4511 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4512 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4513 0) {
4514 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4515 }
4516 }
4517 } else {
4518 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4519 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4520 : format_properties.optimalTilingFeatures;
4521 }
4522
4523 if (tiling_features == 0) {
4524 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4525 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4526 "physical device.",
4527 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4528 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4529 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4530 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4531 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4532 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4533 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4534 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4535 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4536 "VK_IMAGE_USAGE_STORAGE_BIT.",
4537 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4538 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4539 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4540 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4541 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4542 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4543 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4544 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4545 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4546 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4547 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4548 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4549 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4550 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4551 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4552 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4553 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4554 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4555 }
4556
4557 return skip;
4558}
4559
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004560bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004561 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004562 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004563 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004564 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004565 skip |=
4566 ValidateImageUsageFlags(image_state,
4567 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4568 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07004569 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
4570 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4571 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004572 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07004573 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004574 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004575 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004576 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004577 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004578 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004579 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004580
4581 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4582 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004583 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004584 VkFormat view_format = pCreateInfo->format;
4585 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004586 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004587 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004588
Dave Houltonbd2e2622018-04-10 16:41:14 -06004589 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004590 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004591 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004592 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004593 if (!device_extensions.vk_ext_separate_stencil_usage) {
4594 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004595 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4596 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4597 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004598 }
4599 } else {
4600 const auto image_stencil_struct =
4601 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4602 if (image_stencil_struct == nullptr) {
4603 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004604 skip |= LogError(
4605 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004606 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4607 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4608 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4609 }
4610 } else {
4611 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4612 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4613 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004614 skip |= LogError(
4615 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004616 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4617 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4618 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4619 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4620 }
4621 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4622 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004623 skip |= LogError(
4624 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004625 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4626 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4627 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4628 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4629 }
4630 }
4631 }
4632 }
4633
Dave Houltonbd2e2622018-04-10 16:41:14 -06004634 image_usage = chained_ivuci_struct->usage;
4635 }
4636
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004637 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4638 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004639 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004640 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004641 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004642 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004643 std::stringstream ss;
4644 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004645 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004646 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004647 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004648 }
4649 } else {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004650 if ((!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) || (!FormatIsMultiplane(image_format))) {
Dave Houltonc7988072018-04-16 11:46:56 -06004651 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4652 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004653 const char *error_vuid;
4654 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4655 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4656 } else if ((device_extensions.vk_khr_maintenance2) &&
4657 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4658 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4659 } else if ((!device_extensions.vk_khr_maintenance2) &&
4660 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4661 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4662 } else {
4663 // both enabled
4664 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4665 }
Dave Houltonc7988072018-04-16 11:46:56 -06004666 std::stringstream ss;
4667 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004668 << " is not in the same format compatibility class as "
4669 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004670 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4671 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004672 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004673 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004674 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004675 }
4676 } else {
4677 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004678 // Unless it is a multi-planar color bit aspect
4679 if ((image_format != view_format) &&
4680 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4681 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4682 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004683 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004684 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004685 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004686 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004687 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004688 }
4689 }
4690
4691 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004692 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004693
4694 switch (image_type) {
4695 case VK_IMAGE_TYPE_1D:
4696 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004697 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4698 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4699 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004700 }
4701 break;
4702 case VK_IMAGE_TYPE_2D:
4703 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4704 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4705 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004706 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4707 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4708 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004709 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004710 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4711 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4712 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004713 }
4714 }
4715 break;
4716 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004717 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004718 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4719 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4720 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004721 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004722 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4723 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4724 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004725 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4726 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004727 skip |= LogError(
4728 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4729 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4730 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4731 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4732 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004733 }
4734 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004735 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4736 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4737 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004738 }
4739 }
4740 } else {
4741 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004742 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4743 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4744 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004745 }
4746 }
4747 break;
4748 default:
4749 break;
4750 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004751
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004752 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004753 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004754 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004755 }
4756
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004757 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004758
Jeff Bolz9af91c52018-09-01 21:53:57 -05004759 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4760 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004761 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4762 "vkCreateImageView() If image was created with usage containing "
4763 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4764 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004765 }
4766 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004767 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4768 "vkCreateImageView() If image was created with usage containing "
4769 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004770 }
4771 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05004772
4773 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
4774 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
4775 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
4776 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
4777 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
4778 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
4779 }
4780 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
4781 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
4782 skip |= LogError(
4783 device, "VUID-VkImageViewCreateInfo-viewType-02963",
4784 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
4785 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
4786 }
4787 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004788
4789 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
4790 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06004791 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004792 "vkCreateImageView(): If image was created with usage containing "
4793 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
4794 pCreateInfo->subresourceRange.levelCount);
4795 }
4796 }
4797 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
4798 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06004799 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004800 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
4801 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
4802 }
4803 } else {
4804 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
4805 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
4806 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06004807 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004808 "vkCreateImageView(): If image was created with usage containing "
4809 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
4810 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
4811 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
4812 }
4813 }
4814 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07004815
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02004816 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
4817 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
4818 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
4819 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
4820 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
4821 }
4822 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
4823 skip |=
4824 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
4825 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
4826 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
4827 }
4828 }
4829 if (device_extensions.vk_ext_fragment_density_map_2) {
4830 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
4831 (pCreateInfo->subresourceRange.layerCount >
4832 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
4833 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
4834 "vkCreateImageView(): If image was created with flags containing "
4835 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
4836 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
4837 pCreateInfo->subresourceRange.layerCount,
4838 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
4839 }
4840 }
4841
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07004842 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
4843 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
4844 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
4845 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
4846 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
4847 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
4848 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
4849 }
4850 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004851 }
4852 return skip;
4853}
4854
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004855bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4856 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004857 bool skip = false;
4858
4859 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4860 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4861 VkDeviceSize src_min = UINT64_MAX;
4862 VkDeviceSize src_max = 0;
4863 VkDeviceSize dst_min = UINT64_MAX;
4864 VkDeviceSize dst_max = 0;
4865
4866 for (uint32_t i = 0; i < regionCount; i++) {
4867 src_min = std::min(src_min, pRegions[i].srcOffset);
4868 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4869 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4870 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4871
4872 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4873 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004874 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
4875 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4876 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4877 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004878 }
4879
4880 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4881 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004882 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
4883 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4884 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4885 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004886 }
4887
4888 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4889 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004890 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
4891 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4892 ") is greater than the source buffer size (%" PRIuLEAST64
4893 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4894 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004895 }
4896
4897 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4898 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004899 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
4900 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4901 ") is greater than the destination buffer size (%" PRIuLEAST64
4902 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4903 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004904 }
4905 }
4906
4907 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4908 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4909 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004910 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
4911 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004912 }
4913 }
4914
4915 return skip;
4916}
4917
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004918bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004919 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004920 const auto cb_node = GetCBState(commandBuffer);
4921 const auto src_buffer_state = GetBufferState(srcBuffer);
4922 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004923
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004924 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004925 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4926 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004927 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004928 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004929 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4930 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004931 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004932 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4933 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004934 skip |=
4935 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4936 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004937 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4938 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004939 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
sfricke-samsung022fa252020-07-24 03:26:16 -07004940 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
4941 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
4942 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004943 return skip;
4944}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004945
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004946bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004947 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004948 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07004949 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004950 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004951 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
4952 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004953 }
4954 }
4955 return skip;
4956}
4957
Jeff Bolz5c801d12019-10-09 10:38:45 -05004958bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4959 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004960 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004961 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004962
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004963 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004964 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004965 skip |=
4966 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004967 }
4968 return skip;
4969}
4970
Jeff Bolz5c801d12019-10-09 10:38:45 -05004971bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004972 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004973
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004974 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004975 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004976 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004977 }
4978 return skip;
4979}
4980
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004981bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004982 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004983 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004984 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004985 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004986 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004987 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004988 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004989 }
4990 return skip;
4991}
4992
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004993bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004994 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004995 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004996 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004997 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004998 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004999 skip |=
5000 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5001 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005002 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005003 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005004 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5005 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005006 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005007
sfricke-samsung022fa252020-07-24 03:26:16 -07005008 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5009 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5010
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005011 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005012 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5013 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5014 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5015 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005016 }
5017
5018 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005019 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5020 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5021 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5022 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005023 }
5024
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005025 return skip;
5026}
5027
sfricke-samsungd0659242020-08-18 22:38:43 -07005028bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
5029 const VkBufferImageCopy *pRegions, const IMAGE_STATE *image_state,
5030 const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005031 bool skip = false;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005032 assert(image_state != nullptr);
5033 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005034
5035 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005036 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005037 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5038 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005039 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005040 LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-srcImage-00199",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005041 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5042 "and 1, respectively.",
5043 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005044 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005045 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005046
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005047 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5048 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005049 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-srcImage-00201",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005050 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
5051 "must be 0 and 1, respectively.",
5052 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005053 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005054 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005055
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005056 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5057 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005058 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005059 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5060 "For 3D images these must be 0 and 1, respectively.",
5061 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005062 }
5063 }
5064
5065 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005066 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005067 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005068
sfricke-samsung125d2b42020-05-28 06:32:43 -07005069 // If not depth/stencil and not multi-plane
5070 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5071 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005072 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5073 ? "VUID-vkCmdCopyBufferToImage-bufferOffset-01558"
5074 : "VUID-vkCmdCopyBufferToImage-bufferOffset-00193";
sfricke-samsung125d2b42020-05-28 06:32:43 -07005075 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005076 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5077 " must be a multiple of this format's texel size (%" PRIu32 ").",
5078 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005079 }
5080
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005081 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5082 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005083 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005084 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
5085 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5086 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005087 }
5088
5089 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5090 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005091 skip |= LogError(
5092 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005093 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5094 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005095 }
5096
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005097 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005098 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005099 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005100 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 -06005101 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5102 static_cast<int32_t>(adjusted_image_extent.width))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005103 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00197",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005104 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5105 "zero or <= image subresource width (%d).",
5106 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005107 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005108 }
5109
5110 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005111 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 -06005112 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5113 static_cast<int32_t>(adjusted_image_extent.height))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005114 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00198",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005115 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5116 "zero or <= image subresource height (%d).",
5117 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005118 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005119 }
5120
5121 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005122 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 -06005123 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5124 static_cast<int32_t>(adjusted_image_extent.depth))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005125 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005126 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5127 "zero or <= image subresource depth (%d).",
5128 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005129 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005130 }
5131
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005132 // subresource aspectMask must have exactly 1 bit set
5133 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005134 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005135 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005136 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005137 "%s(): aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005138 }
5139
5140 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005141 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005142 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005143 image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005144 "%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 -07005145 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005146 }
5147
5148 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005149 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5150 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005151
5152 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005153 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005154 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005155 ? "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203"
5156 : "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005157 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005158 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005159 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5160 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005161 }
5162
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005163 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005164 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005165 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005166 ? "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204"
5167 : "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005168 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005169 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005170 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5171 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005172 }
5173
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005174 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005175 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5176 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5177 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005178 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5179 ? "VUID-vkCmdCopyBufferToImage-imageOffset-00205"
5180 : "VUID-vkCmdCopyBufferToImage-imageOffset-00205";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005181 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005182 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5183 "width & height (%d, %d)..",
5184 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5185 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005186 }
5187
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005188 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005189 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005190 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005191 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005192 ? "VUID-vkCmdCopyBufferToImage-bufferOffset-00206"
5193 : "VUID-vkCmdCopyBufferToImage-bufferOffset-00206";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005194 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005195 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5196 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5197 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005198 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005199
5200 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005201 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005202 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005203 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005204 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5205 ? "VUID-vkCmdCopyBufferToImage-imageExtent-00207"
5206 : "VUID-vkCmdCopyBufferToImage-imageExtent-00207";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005207 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005208 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5209 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5210 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5211 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005212 }
5213
5214 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005215 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005216 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005217 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5218 ? "VUID-vkCmdCopyBufferToImage-imageExtent-00208"
5219 : "VUID-vkCmdCopyBufferToImage-imageExtent-00208";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005220 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005221 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5222 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5223 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5224 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005225 }
5226
5227 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005228 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005229 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005230 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5231 ? "VUID-vkCmdCopyBufferToImage-imageExtent-00209"
5232 : "VUID-vkCmdCopyBufferToImage-imageExtent-00209";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005233 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005234 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5235 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5236 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5237 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005238 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005239 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005240
5241 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005242 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005243 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005244 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005245 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005246 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5247 "format has three planes.",
5248 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005249 }
5250
5251 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005252 if (0 ==
5253 (region_aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005254 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005255 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5256 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5257 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005258 } else {
5259 // Know aspect mask is valid
5260 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5261 const uint32_t compatible_size = FormatElementSize(compatible_format);
5262 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5263 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005264 image_state->image, "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
sfricke-samsung125d2b42020-05-28 06:32:43 -07005265 "%s(): pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
5266 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5267 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5268 string_VkFormat(compatible_format));
5269 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005270 }
5271 }
sfricke-samsungd0659242020-08-18 22:38:43 -07005272
5273 // Checks depth or stencil aspect are used in graphics queue
5274 if ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0) {
5275 assert(cb_node != nullptr);
5276 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
5277 if (command_pool != nullptr) {
5278 const uint32_t queueFamilyIndex = command_pool->queueFamilyIndex;
5279 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queueFamilyIndex].queueFlags;
5280
5281 if ((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) {
5282 LogObjectList objlist(cb_node->commandBuffer);
5283 objlist.add(command_pool->commandPool);
5284 // TODO - Label when future headers get merged in from internral MR 4077 fix
5285 skip |=
5286 LogError(image_state->image, "UNASSIGNED-VkBufferImageCopy-aspectMask",
5287 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
5288 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
5289 "which was create with queueFamilyIndex %u which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
5290 function, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
5291 report_data->FormatHandle(command_pool->commandPool).c_str(), queueFamilyIndex);
5292 }
5293 }
5294 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005295 }
5296
5297 return skip;
5298}
5299
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005300bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5301 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005302 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005303 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005304
5305 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005306 VkExtent3D extent = pRegions[i].imageExtent;
5307 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005308
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005309 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5310 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005311 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5312 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5313 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005314 }
5315
5316 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5317
5318 // 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 -06005319 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005320 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005321 if (image_extent.width % block_extent.width) {
5322 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5323 }
5324 if (image_extent.height % block_extent.height) {
5325 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5326 }
5327 if (image_extent.depth % block_extent.depth) {
5328 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5329 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005330 }
5331
Dave Houltonfc1a4052017-04-27 14:32:45 -06005332 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005333 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005334 }
5335 }
5336
5337 return skip;
5338}
5339
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005340bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5341 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005342 bool skip = false;
5343
5344 VkDeviceSize buffer_size = buff_state->createInfo.size;
5345
5346 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005347 VkDeviceSize max_buffer_offset =
5348 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5349 if (buffer_size < max_buffer_offset) {
5350 skip |=
5351 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 -07005352 }
5353 }
5354
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005355 return skip;
5356}
5357
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005358bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005359 VkBuffer dstBuffer, uint32_t regionCount,
5360 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005361 const auto cb_node = GetCBState(commandBuffer);
5362 const auto src_image_state = GetImageState(srcImage);
5363 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005364
sfricke-samsungd0659242020-08-18 22:38:43 -07005365 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005366
5367 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005368 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005369
5370 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005371 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005372
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005373 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005374
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005375 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005376 skip |=
5377 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5378 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5379 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005380 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005381 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005382 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005383 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005384 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005385
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005386 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005387 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005388 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5389 skip |=
5390 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005391
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005392 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005393 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005394 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5395 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005396 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005397 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5398 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
sfricke-samsung022fa252020-07-24 03:26:16 -07005399 skip |= ValidateProtectedImage(cb_node, src_image_state, "vkCmdCopyImageToBuffer()",
5400 "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831");
5401 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyImageToBuffer()",
5402 "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832");
5403 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyImageToBuffer()",
5404 "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005405
5406 // Validation for VK_EXT_fragment_density_map
5407 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5408 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyImageToBuffer-srcImage-02544",
5409 "vkCmdCopyBufferToImage(): srcImage must not have been created with flags containing "
5410 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5411 }
5412
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005413 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005414 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005415 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005416 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005417 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005418 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005419 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5420 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5421 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005422 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005423 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005424 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005425 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005426 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5427 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005428 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5429 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5430 skip |=
5431 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5432 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5433 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005434 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5435 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005436 }
5437 return skip;
5438}
5439
John Zulauf1686f232019-07-09 16:27:11 -06005440void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5441 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5442 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5443
5444 auto cb_node = GetCBState(commandBuffer);
5445 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005446 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005447 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005448 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005449 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005450}
5451
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005452bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5453 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005454 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005455 const auto cb_node = GetCBState(commandBuffer);
5456 const auto src_buffer_state = GetBufferState(srcBuffer);
5457 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005458
sfricke-samsungd0659242020-08-18 22:38:43 -07005459 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005460
5461 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005462 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005463
5464 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005465 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005466 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005467 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005468 skip |=
5469 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5470 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5471 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005472 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005473 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005474 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005475 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005476 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005477 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005478 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005479 skip |=
5480 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5481 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005482 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005483 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5484 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005485 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005486 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5487 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
sfricke-samsung022fa252020-07-24 03:26:16 -07005488 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBufferToImage()",
5489 "VUID-vkCmdCopyBufferToImage-commandBuffer-01828");
5490 skip |= ValidateProtectedImage(cb_node, dst_image_state, "vkCmdCopyBufferToImage()",
5491 "VUID-vkCmdCopyBufferToImage-commandBuffer-01829");
5492 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdCopyBufferToImage()",
5493 "VUID-vkCmdCopyBufferToImage-commandBuffer-01830");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005494
5495 // Validation for VK_EXT_fragment_density_map
5496 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5497 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyBufferToImage-dstImage-02543",
5498 "vkCmdCopyBufferToImage(): dstImage must not have been created with flags containing "
5499 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5500 }
5501
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005502 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005503 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005504 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005505 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005506 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005507 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005508 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5509 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5510 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005511 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005512 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005513 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005514 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005515 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5516 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005517 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5518 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5519 skip |=
5520 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5521 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5522 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005523 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5524 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005525 }
5526 return skip;
5527}
5528
John Zulauf1686f232019-07-09 16:27:11 -06005529void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5530 VkImageLayout dstImageLayout, uint32_t regionCount,
5531 const VkBufferImageCopy *pRegions) {
5532 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5533
5534 auto cb_node = GetCBState(commandBuffer);
5535 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005536 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005537 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005538 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005539 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005540}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005541
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005542bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005543 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005544 bool skip = false;
5545 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5546
Dave Houlton1d960ff2018-01-19 12:17:05 -07005547 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005548 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5549 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5550 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005551 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5552 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005553 }
5554
John Zulaufa26d3c82019-08-14 16:09:08 -06005555 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005556 if (!image_entry) {
5557 return skip;
5558 }
5559
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005560 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5561 if (device_extensions.vk_ext_image_drm_format_modifier) {
5562 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5563 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005564 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5565 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5566 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005567 }
5568 } else {
5569 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005570 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5571 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005572 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005573 }
5574
Dave Houlton1d960ff2018-01-19 12:17:05 -07005575 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005576 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005577 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5578 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5579 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005580 }
5581
Dave Houlton1d960ff2018-01-19 12:17:05 -07005582 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005583 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005584 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5585 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5586 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005587 }
5588
Dave Houlton1d960ff2018-01-19 12:17:05 -07005589 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005590 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005591 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5592 if (FormatIsMultiplane(img_format)) {
5593 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5594 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5595 if (FormatPlaneCount(img_format) > 2u) {
5596 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5597 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5598 }
5599 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005600 skip |= LogError(image, vuid,
5601 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5602 ") must be a single-plane specifier flag.",
5603 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005604 }
5605 } else if (FormatIsColor(img_format)) {
5606 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005607 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5608 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5609 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005610 }
5611 } else if (FormatIsDepthOrStencil(img_format)) {
5612 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5613 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005614 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005615 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5616 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5617 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5618 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005619 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5620 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5621 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005622 }
5623 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005624
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005625 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005626 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005627 }
5628
Mike Weiblen672b58b2017-02-21 14:32:53 -07005629 return skip;
5630}
sfricke-samsung022fa252020-07-24 03:26:16 -07005631
5632// Validates the image is allowed to be protected
5633bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
5634 const char *vuid) const {
5635 bool skip = false;
5636 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
5637 LogObjectList objlist(cb_state->commandBuffer);
5638 objlist.add(image_state->image);
5639 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while image %s is a protected image", cmd_name,
5640 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
5641 report_data->FormatHandle(image_state->image).c_str());
5642 }
5643 return skip;
5644}
5645
5646// Validates the image is allowed to be unprotected
5647bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
5648 const char *vuid) const {
5649 bool skip = false;
5650 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
5651 LogObjectList objlist(cb_state->commandBuffer);
5652 objlist.add(image_state->image);
5653 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while image %s is an unprotected image", cmd_name,
5654 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
5655 report_data->FormatHandle(image_state->image).c_str());
5656 }
5657 return skip;
5658}
5659
5660// Validates the buffer is allowed to be protected
5661bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
5662 const char *vuid) const {
5663 bool skip = false;
5664 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
5665 LogObjectList objlist(cb_state->commandBuffer);
5666 objlist.add(buffer_state->buffer);
5667 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while buffer %s is a protected buffer", cmd_name,
5668 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
5669 report_data->FormatHandle(buffer_state->buffer).c_str());
5670 }
5671 return skip;
5672}
5673
5674// Validates the buffer is allowed to be unprotected
5675bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
5676 const char *vuid) const {
5677 bool skip = false;
5678 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
5679 LogObjectList objlist(cb_state->commandBuffer);
5680 objlist.add(buffer_state->buffer);
5681 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while buffer %s is an unprotected buffer", cmd_name,
5682 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
5683 report_data->FormatHandle(buffer_state->buffer).c_str());
5684 }
5685 return skip;
5686}