blob: 398ad1c9ba4ee8e8c30e3eff8a0ba2d18d99d07a [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
locke-lunarg36045992020-08-20 16:54:37 -0600279const cvdescriptorset::Descriptor *CMD_BUFFER_STATE::GetDescriptor(VkShaderStageFlagBits shader_stage, uint32_t set,
280 uint32_t binding, uint32_t index) const {
281 VkPipelineBindPoint bind_point;
282
283 if (shader_stage & VK_SHADER_STAGE_ALL_GRAPHICS) {
284 bind_point = VK_PIPELINE_BIND_POINT_GRAPHICS;
285 } else if (shader_stage & VK_SHADER_STAGE_COMPUTE_BIT) {
286 bind_point = VK_PIPELINE_BIND_POINT_COMPUTE;
287 } else {
288 bind_point = VK_PIPELINE_BIND_POINT_RAY_TRACING_KHR;
289 }
290
291 return GetDescriptor(bind_point, set, binding, index);
292}
293
294const cvdescriptorset::Descriptor *CMD_BUFFER_STATE::GetDescriptor(VkPipelineBindPoint bind_point, uint32_t set, uint32_t binding,
295 uint32_t index) const {
296 const auto last_bound_it = lastBound.find(bind_point);
297 if (last_bound_it == lastBound.cend()) {
298 return nullptr;
299 }
300 if (set >= last_bound_it->second.per_set.size()) {
301 return nullptr;
302 }
303 return last_bound_it->second.per_set[set].bound_descriptor_set->GetDescriptorFromBinding(binding, index);
304}
305
Dave Houltond9611312018-11-19 17:03:36 -0700306uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
307 // uint cast applies floor()
308 return 1u + (uint32_t)log2(std::max({height, width, depth}));
309}
310
311uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
312
313uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
314
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500315bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700316 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700317 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700318
John Zulauf2076e812020-01-08 14:55:54 -0700319 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
320 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700321 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
322 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
323
John Zulauf2076e812020-01-08 14:55:54 -0700324 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
325
326 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
327 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700328 return false;
329 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700330
John Zulauf2076e812020-01-08 14:55:54 -0700331 for (auto entry : *layout_range_map) {
332 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700333 }
334 return true;
335}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700336
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600337// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600338void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600339 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
340 VkImageLayout expected_layout) {
341 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
342 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600343 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600344 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700345 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700346 for (const auto &image : image_state.aliasing_images) {
347 auto alias_state = GetImageState(image);
348 // The map state of the aliases should all be in sync, so no need to check the return value
349 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
350 assert(subresource_map);
351 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
352 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700353}
John Zulauff660ad62019-03-23 07:16:05 -0600354
355// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600356void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600357 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500358 return;
359 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500360 IMAGE_STATE *image_state = view_state.image_state.get();
361 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700362 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700363 for (const auto &image : image_state->aliasing_images) {
364 image_state = GetImageState(image);
365 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
366 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
367 }
John Zulauff660ad62019-03-23 07:16:05 -0600368}
369
370// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600371void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600372 const VkImageSubresourceRange &range, VkImageLayout layout) {
373 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
374 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600375 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700376 for (const auto &image : image_state.aliasing_images) {
377 auto alias_state = GetImageState(image);
378 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
379 assert(subresource_map);
380 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
381 }
John Zulauff660ad62019-03-23 07:16:05 -0600382}
383
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600384void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600385 VkImageLayout layout) {
386 const IMAGE_STATE *image_state = GetImageState(image);
387 if (!image_state) return;
388 SetImageInitialLayout(cb_node, *image_state, range, layout);
389};
390
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600391void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600392 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
393 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600394}
Dave Houltonddd65c52018-05-08 14:58:01 -0600395
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600396// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700397void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
398 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500399 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600400
John Zulauff660ad62019-03-23 07:16:05 -0600401 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600402 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
403 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600404 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 -0600405 sub_range.baseArrayLayer = 0;
406 sub_range.layerCount = image_state->createInfo.extent.depth;
407 }
408
Piers Daniell4fde9b72019-11-27 16:19:46 -0700409 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
410 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
411 SetImageLayout(cb_node, *image_state, sub_range, layout);
412 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
413 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
414 } else {
415 SetImageLayout(cb_node, *image_state, sub_range, layout);
416 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600417}
418
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700419bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
420 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700421 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600422 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100423 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700424 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100425 const char *vuid;
426 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700427 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100428
429 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600430 LogObjectList objlist(image);
431 objlist.add(renderpass);
432 objlist.add(framebuffer);
433 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700434 skip |=
435 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
436 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
437 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
438 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100439 return skip;
440 }
441
442 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200443 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
444 if (stencil_usage_info) {
445 image_usage |= stencil_usage_info->stencilUsage;
446 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100447
448 // Check for layouts that mismatch image usages in the framebuffer
449 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800450 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600451 LogObjectList objlist(image);
452 objlist.add(renderpass);
453 objlist.add(framebuffer);
454 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700455 skip |= LogError(objlist, vuid,
456 "%s: Layout/usage mismatch for attachment %u in %s"
457 " - the %s is %s but the image attached to %s via %s"
458 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
459 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
460 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
461 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100462 }
463
464 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
465 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800466 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600467 LogObjectList objlist(image);
468 objlist.add(renderpass);
469 objlist.add(framebuffer);
470 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700471 skip |= LogError(objlist, vuid,
472 "%s: Layout/usage mismatch for attachment %u in %s"
473 " - the %s is %s but the image attached to %s via %s"
474 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
475 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
476 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
477 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100478 }
479
480 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800481 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600482 LogObjectList objlist(image);
483 objlist.add(renderpass);
484 objlist.add(framebuffer);
485 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700486 skip |= LogError(objlist, vuid,
487 "%s: Layout/usage mismatch for attachment %u in %s"
488 " - the %s is %s but the image attached to %s via %s"
489 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
490 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
491 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
492 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100493 }
494
495 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800496 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600497 LogObjectList objlist(image);
498 objlist.add(renderpass);
499 objlist.add(framebuffer);
500 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700501 skip |= LogError(objlist, vuid,
502 "%s: Layout/usage mismatch for attachment %u in %s"
503 " - the %s is %s but the image attached to %s via %s"
504 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
505 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
506 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
507 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100508 }
509
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600510 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100511 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
512 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
513 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
514 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
515 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800516 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600517 LogObjectList objlist(image);
518 objlist.add(renderpass);
519 objlist.add(framebuffer);
520 objlist.add(image_view);
521 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700522 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700523 " - the %s is %s but the image attached to %s via %s"
524 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700525 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700526 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
527 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100528 }
529 } else {
530 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
531 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
532 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
533 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600534 LogObjectList objlist(image);
535 objlist.add(renderpass);
536 objlist.add(framebuffer);
537 objlist.add(image_view);
538 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700539 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700540 " - the %s is %s but the image attached to %s via %s"
541 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700542 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700543 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
544 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100545 }
546 }
547 return skip;
548}
549
John Zulauf17a01bb2019-08-09 16:41:19 -0600550bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700551 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600552 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600553 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700554 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700555 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100556 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100557
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700558 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100559 auto framebuffer = framebuffer_state->framebuffer;
560
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700561 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700562 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
563 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700564 }
John Zulauf8e308292018-09-21 11:34:37 -0600565
Tobias Hectorc9057422019-07-23 12:15:52 +0100566 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
567 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
568 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100569 }
570
Tobias Hectorc9057422019-07-23 12:15:52 +0100571 if (attachments != nullptr) {
572 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
573 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
574 auto image_view = attachments[i];
575 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100576
Tobias Hectorc9057422019-07-23 12:15:52 +0100577 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600578 LogObjectList objlist(pRenderPassBegin->renderPass);
579 objlist.add(framebuffer_state->framebuffer);
580 objlist.add(image_view);
581 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700582 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
583 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
584 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100585 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100586 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100587
588 const VkImage image = view_state->create_info.image;
589 const IMAGE_STATE *image_state = GetImageState(image);
590
591 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600592 LogObjectList objlist(pRenderPassBegin->renderPass);
593 objlist.add(framebuffer_state->framebuffer);
594 objlist.add(image_view);
595 objlist.add(image);
596 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700597 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
598 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
599 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100600 continue;
601 }
602 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
603 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
604
Piers Daniell7f894f62020-01-09 16:33:48 -0700605 // Default to expecting stencil in the same layout.
606 auto attachment_stencil_initial_layout = attachment_initial_layout;
607
608 // If a separate layout is specified, look for that.
609 const auto *attachment_description_stencil_layout =
610 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
611 if (attachment_description_stencil_layout) {
612 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
613 }
614
Tobias Hectorc9057422019-07-23 12:15:52 +0100615 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
616 // in common with the non-const version.)
617 const ImageSubresourceLayoutMap *subresource_map =
618 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
619
620 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
621 LayoutUseCheckAndMessage layout_check(subresource_map);
622 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700623 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
624 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
625 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700626
John Zulauf5e617452019-11-19 14:44:16 -0700627 // Allow for differing depth and stencil layouts
628 VkImageLayout check_layout = attachment_initial_layout;
629 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
630
631 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700632 subres_skip |= LogError(
633 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700634 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
635 "and the %s layout of the attachment is %s. The layouts must match, or the render "
636 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700637 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100638 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700639 }
John Zulauf5e617452019-11-19 14:44:16 -0700640
Tobias Hectorc9057422019-07-23 12:15:52 +0100641 skip |= subres_skip;
642 }
643
644 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
645 framebuffer, render_pass, i, "initial layout");
646
647 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
648 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100649 }
650
Tobias Hectorc9057422019-07-23 12:15:52 +0100651 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
652 auto &subpass = pRenderPassInfo->pSubpasses[j];
653 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
654 auto &attachment_ref = subpass.pInputAttachments[k];
655 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
656 auto image_view = attachments[attachment_ref.attachment];
657 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100658
Tobias Hectorc9057422019-07-23 12:15:52 +0100659 if (view_state) {
660 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700661 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
662 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100663 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100664 }
665 }
666 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100667
Tobias Hectorc9057422019-07-23 12:15:52 +0100668 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
669 auto &attachment_ref = subpass.pColorAttachments[k];
670 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
671 auto image_view = attachments[attachment_ref.attachment];
672 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100673
Tobias Hectorc9057422019-07-23 12:15:52 +0100674 if (view_state) {
675 auto image = view_state->create_info.image;
676 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
677 framebuffer, render_pass, attachment_ref.attachment,
678 "color attachment layout");
679 if (subpass.pResolveAttachments) {
680 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
681 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
682 attachment_ref.attachment, "resolve attachment layout");
683 }
684 }
685 }
686 }
687
688 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
689 auto &attachment_ref = *subpass.pDepthStencilAttachment;
690 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
691 auto image_view = attachments[attachment_ref.attachment];
692 auto view_state = GetImageViewState(image_view);
693
694 if (view_state) {
695 auto image = view_state->create_info.image;
696 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
697 framebuffer, render_pass, attachment_ref.attachment,
698 "input attachment layout");
699 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100700 }
701 }
702 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700703 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600704 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700705}
706
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600707void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700708 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700709 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700710 IMAGE_VIEW_STATE *image_view = nullptr;
711 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
712 const auto attachment_info =
713 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
714 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
715 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300716 image_view = GetAttachmentImageViewState(pCB, pFramebuffer, ref.attachment);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700717 }
John Zulauf8e308292018-09-21 11:34:37 -0600718 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700719 VkImageLayout stencil_layout = kInvalidLayout;
720 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
721 if (attachment_reference_stencil_layout) {
722 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
723 }
724
725 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600726 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700727 }
728}
729
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600730void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
731 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700732 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700733
734 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700735 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700736 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700737 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700738 }
739 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700740 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700741 }
742 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700743 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700744 }
745 }
746}
747
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700748// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
749// 1. Transition into initialLayout state
750// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600751void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700752 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700753 // First transition into initialLayout
754 auto const rpci = render_pass_state->createInfo.ptr();
755 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700756 IMAGE_VIEW_STATE *view_state = nullptr;
757 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
758 const auto attachment_info =
759 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
760 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
761 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300762 view_state = GetAttachmentImageViewState(cb_state, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700763 }
John Zulauf8e308292018-09-21 11:34:37 -0600764 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700765 VkImageLayout stencil_layout = kInvalidLayout;
766 const auto *attachment_description_stencil_layout =
767 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
768 if (attachment_description_stencil_layout) {
769 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
770 }
771
772 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600773 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700774 }
775 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700776 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700777}
778
Dave Houlton10b39482017-03-16 13:18:15 -0600779bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600780 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600781 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600782 }
783 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600784 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600785 }
786 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600787 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600788 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700789 if (0 !=
790 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
791 if (FormatPlaneCount(format) == 1) return false;
792 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600793 return true;
794}
795
Mike Weiblen62d08a32017-03-07 22:18:27 -0700796// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200797bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
798 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600799 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700800 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200801 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600802 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700803
804 switch (layout) {
805 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
806 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600807 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700808 }
809 break;
810 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
811 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600812 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700813 }
814 break;
815 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
816 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600817 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700818 }
819 break;
820 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
821 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600822 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700823 }
824 break;
825 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
826 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600827 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700828 }
829 break;
830 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
831 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600832 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700833 }
834 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600835 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500836 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
837 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
838 }
839 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700840 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
841 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
842 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
843 }
844 break;
845 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
846 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
847 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
848 }
849 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700850 default:
851 // Other VkImageLayout values do not have VUs defined in this context.
852 break;
853 }
854
Dave Houlton8e9f6542018-05-18 12:18:22 -0600855 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700856 skip |= LogError(img_barrier.image, msg_code,
857 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
858 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
859 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700860 }
861 return skip;
862}
863
864// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600865bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
866 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700867 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700868
Petr Krausad0096a2019-08-09 18:35:04 +0200869 // Scoreboard for checking for duplicate and inconsistent barriers to images
870 struct ImageBarrierScoreboardEntry {
871 uint32_t index;
872 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
873 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
874 const VkImageMemoryBarrier *barrier;
875 };
876 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
877 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
878
John Zulauf463c51e2018-05-31 13:29:20 -0600879 // Scoreboard for duplicate layout transition barriers within the list
880 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
881 ImageBarrierScoreboardImageMap layout_transitions;
882
Mike Weiblen62d08a32017-03-07 22:18:27 -0700883 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200884 const auto &img_barrier = pImageMemoryBarriers[i];
885 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700886
John Zulauf463c51e2018-05-31 13:29:20 -0600887 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
888 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
889 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200890 if (img_barrier.oldLayout != img_barrier.newLayout) {
891 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
892 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600893 if (image_it != layout_transitions.end()) {
894 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200895 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600896 if (subres_it != subres_map.end()) {
897 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200898 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
899 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
900 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700901 skip = LogError(
902 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200903 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600904 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
905 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200906 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
907 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
908 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600909 }
910 entry = new_entry;
911 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200912 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600913 }
914 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200915 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600916 }
917 }
918
Petr Krausad0096a2019-08-09 18:35:04 +0200919 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600920 if (image_state) {
921 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200922 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
923 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600924
925 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
926 if (image_state->layout_locked) {
927 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700928 skip |= LogError(
929 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700930 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600931 " 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 -0700932 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200933 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600934 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600935
John Zulaufa4472282019-08-22 14:44:34 -0600936 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700937 const VkFormat image_format = image_create_info.format;
938 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600939 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700940 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700941 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600942 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
943 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700944 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
945 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
946 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
947 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700948 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600949 }
950 } else {
951 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
952 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -0700953 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
954 ? "VUID-VkImageMemoryBarrier-image-03320"
955 : "VUID-VkImageMemoryBarrier-image-01207";
956 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700957 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
958 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
959 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700960 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600961 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700962 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700963 }
John Zulauff660ad62019-03-23 07:16:05 -0600964
Petr Krausad0096a2019-08-09 18:35:04 +0200965 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
966 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600967 // TODO: Set memory invalid which is in mem_tracker currently
968 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
969 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600970 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600971 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600972 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200973 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700974 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
975 const auto &value = *pos;
976 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700977 subres_skip = LogError(
978 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700979 "%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 -0700980 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700981 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -0700982 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
983 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600984 }
John Zulauf5e617452019-11-19 14:44:16 -0700985 }
John Zulauff660ad62019-03-23 07:16:05 -0600986 skip |= subres_skip;
987 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700988
989 // checks color format and (single-plane or non-disjoint)
990 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
991 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -0700992 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -0700993 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
994 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
995 ? "VUID-VkImageMemoryBarrier-image-01671"
996 : "VUID-VkImageMemoryBarrier-image-02902";
997 skip |= LogError(img_barrier.image, vuid,
998 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
999 "but its aspectMask is 0x%" PRIx32 ".",
1000 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1001 string_VkFormat(image_format), aspect_mask);
1002 }
1003 }
1004
1005 VkImageAspectFlags valid_disjoint_mask =
1006 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 -07001007 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001008 ((aspect_mask & valid_disjoint_mask) == 0)) {
1009 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
1010 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
1011 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
1012 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1013 string_VkFormat(image_format), aspect_mask);
1014 }
1015
1016 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
1017 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
1018 "%s: Image barrier %s references %s of format %s has only two planes but included "
1019 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
1020 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1021 string_VkFormat(image_format), aspect_mask);
1022 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001023 }
1024 }
1025 return skip;
1026}
1027
John Zulaufe3d1c8a2019-08-12 14:34:58 -06001028bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +02001029 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -07001030
Jeff Bolz6835fda2019-10-06 00:15:34 -05001031 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +02001032 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001033}
1034
John Zulauf6b4aae82018-05-09 13:03:36 -06001035template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001036bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
1037 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001038 using BarrierRecord = QFOTransferBarrier<Barrier>;
1039 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001040 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001041 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
1042 const char *barrier_name = BarrierRecord::BarrierName();
1043 const char *handle_name = BarrierRecord::HandleName();
1044 const char *transfer_type = nullptr;
1045 for (uint32_t b = 0; b < barrier_count; b++) {
1046 if (!IsTransferOp(&barriers[b])) continue;
1047 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001048 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001049 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001050 const auto found = barrier_sets.release.find(barriers[b]);
1051 if (found != barrier_sets.release.cend()) {
1052 barrier_record = &(*found);
1053 transfer_type = "releasing";
1054 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -06001055 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001056 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001057 const auto found = barrier_sets.acquire.find(barriers[b]);
1058 if (found != barrier_sets.acquire.cend()) {
1059 barrier_record = &(*found);
1060 transfer_type = "acquiring";
1061 }
1062 }
1063 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001064 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
1065 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1066 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
1067 func_name, barrier_name, b, transfer_type, handle_name,
1068 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
1069 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001070 }
1071 }
1072 return skip;
1073}
1074
John Zulaufa4472282019-08-22 14:44:34 -06001075VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1076 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1077}
1078
1079const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1080 return device_state.GetImageState(barrier.image);
1081}
1082
1083VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1084 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1085}
1086
1087const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1088 return device_state.GetBufferState(barrier.buffer);
1089}
1090
1091VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1092
John Zulauf6b4aae82018-05-09 13:03:36 -06001093template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001094void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1095 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001096 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001097 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1098 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001099 auto &barrier = barriers[b];
1100 if (IsTransferOp(&barrier)) {
1101 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001102 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001103 barrier_sets.release.emplace(barrier);
1104 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001105 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001106 barrier_sets.acquire.emplace(barrier);
1107 }
1108 }
1109
1110 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1111 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1112 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1113 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1114 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1115 auto handle_state = BarrierHandleState(*this, barrier);
1116 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1117 if (!mode_concurrent) {
1118 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001119 cb_state->queue_submit_functions.emplace_back(
1120 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1121 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1122 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1123 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001124 });
1125 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001126 }
1127 }
1128}
1129
John Zulaufa4472282019-08-22 14:44:34 -06001130bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001131 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001132 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001133 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001134 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001135 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1136 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001137 return skip;
1138}
1139
John Zulaufa4472282019-08-22 14:44:34 -06001140void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1141 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1142 const VkImageMemoryBarrier *pImageMemBarriers) {
1143 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1144 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001145}
1146
1147template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001148bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001149 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001150 // Record to the scoreboard or report that we have a duplication
1151 bool skip = false;
1152 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1153 if (!inserted.second && inserted.first->second != cb_state) {
1154 // 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 -06001155 LogObjectList objlist(cb_state->commandBuffer);
1156 objlist.add(barrier.handle);
1157 objlist.add(inserted.first->second->commandBuffer);
1158 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001159 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1160 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1161 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1162 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1163 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001164 }
1165 return skip;
1166}
1167
1168template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001169bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1170 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001171 using BarrierRecord = QFOTransferBarrier<Barrier>;
1172 using TypeTag = typename BarrierRecord::Tag;
1173 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001174 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001175 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001176 const char *barrier_name = BarrierRecord::BarrierName();
1177 const char *handle_name = BarrierRecord::HandleName();
1178 // No release should have an extant duplicate (WARNING)
1179 for (const auto &release : cb_barriers.release) {
1180 // Check the global pending release barriers
1181 const auto set_it = global_release_barriers.find(release.handle);
1182 if (set_it != global_release_barriers.cend()) {
1183 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1184 const auto found = set_for_handle.find(release);
1185 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001186 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1187 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1188 " to dstQueueFamilyIndex %" PRIu32
1189 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1190 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1191 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001192 }
1193 }
1194 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1195 }
1196 // Each acquire must have a matching release (ERROR)
1197 for (const auto &acquire : cb_barriers.acquire) {
1198 const auto set_it = global_release_barriers.find(acquire.handle);
1199 bool matching_release_found = false;
1200 if (set_it != global_release_barriers.cend()) {
1201 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1202 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1203 }
1204 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001205 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1206 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1207 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1208 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1209 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001210 }
1211 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1212 }
1213 return skip;
1214}
1215
John Zulauf3b04ebd2019-07-18 14:08:11 -06001216bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001217 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001218 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001219 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001220 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1221 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001222 return skip;
1223}
1224
1225template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001226void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001227 using BarrierRecord = QFOTransferBarrier<Barrier>;
1228 using TypeTag = typename BarrierRecord::Tag;
1229 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001230 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001231
1232 // Add release barriers from this submit to the global map
1233 for (const auto &release : cb_barriers.release) {
1234 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1235 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1236 global_release_barriers[release.handle].insert(release);
1237 }
1238
1239 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1240 for (const auto &acquire : cb_barriers.acquire) {
1241 // NOTE: We're not using [] because we don't want to create entries for missing releases
1242 auto set_it = global_release_barriers.find(acquire.handle);
1243 if (set_it != global_release_barriers.end()) {
1244 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1245 set_for_handle.erase(acquire);
1246 if (set_for_handle.size() == 0) { // Clean up empty sets
1247 global_release_barriers.erase(set_it);
1248 }
1249 }
1250 }
1251}
1252
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001253void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001254 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1255 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001256}
1257
John Zulauf6b4aae82018-05-09 13:03:36 -06001258// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001259void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001260
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001261void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001262 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001263 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001264 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001265
Chris Forbes4de4b132017-08-21 11:27:08 -07001266 // For ownership transfers, the barrier is specified twice; as a release
1267 // operation on the yielding queue family, and as an acquire operation
1268 // on the acquiring queue family. This barrier may also include a layout
1269 // transition, which occurs 'between' the two operations. For validation
1270 // purposes it doesn't seem important which side performs the layout
1271 // transition, but it must not be performed twice. We'll arbitrarily
1272 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001273 //
1274 // However, we still need to record initial layout for the "initial layout" validation
1275 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001276
Petr Krausad0096a2019-08-09 18:35:04 +02001277 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001278 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001279 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001280 }
1281}
1282
unknown86bcb3a2019-07-11 13:05:36 -06001283void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001284 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001285 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1286 const auto &image_create_info = image_state->createInfo;
1287
1288 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1289 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1290 // for all (potential) layer sub_resources.
1291 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1292 normalized_isr.baseArrayLayer = 0;
1293 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1294 }
1295
Michael Spang8af7c102020-05-03 20:50:09 -04001296 VkImageLayout initial_layout = mem_barrier.oldLayout;
1297
1298 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001299 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001300 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1301 }
1302
John Zulauf2be3fe02019-12-30 09:48:02 -07001303 if (is_release_op) {
1304 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1305 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001306 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001307 }
unknown86bcb3a2019-07-11 13:05:36 -06001308}
1309
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001310bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1311 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1312 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1313 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001314 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001315 assert(cb_node);
1316 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001317 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001318 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001319
John Zulauff660ad62019-03-23 07:16:05 -06001320 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1321 if (subresource_map) {
1322 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001323 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001324 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1325 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001326 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001327 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1328 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1329 "%s layout %s.",
1330 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1331 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1332 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001333 }
John Zulauf5e617452019-11-19 14:44:16 -07001334 }
John Zulauff660ad62019-03-23 07:16:05 -06001335 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001336 }
John Zulauff660ad62019-03-23 07:16:05 -06001337
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001338 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1339 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1340 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001341 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1342 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001343 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1344 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1345 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001346 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001347 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001348 if (image_state->shared_presentable) {
1349 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001350 skip |=
1351 LogError(device, layout_invalid_msg_code,
1352 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1353 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001354 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001355 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001356 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001357 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001358 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1359 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1360 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1361 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001362 }
1363 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001364 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001365}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001366bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001367 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1368 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001369 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001370 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1371 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1372}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001373
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001374void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001375 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001376 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001377 if (!renderPass) return;
1378
Tobias Hectorbbb12282018-10-22 15:17:59 +01001379 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001380 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001381 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001382 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001383 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1384 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1385 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1386 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001387 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001388 }
John Zulauf8e308292018-09-21 11:34:37 -06001389 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001390 VkImageLayout stencil_layout = kInvalidLayout;
1391 const auto *attachment_description_stencil_layout =
1392 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1393 if (attachment_description_stencil_layout) {
1394 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1395 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001396 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001397 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001398 }
1399 }
1400}
Dave Houltone19e20d2018-02-02 16:32:41 -07001401
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001402#ifdef VK_USE_PLATFORM_ANDROID_KHR
1403// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1404// This could also move into a seperate core_validation_android.cpp file... ?
1405
1406//
1407// AHB-specific validation within non-AHB APIs
1408//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001409bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001410 bool skip = false;
1411
1412 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1413 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001414 if (0 != ext_fmt_android->externalFormat) {
1415 if (VK_FORMAT_UNDEFINED != create_info->format) {
1416 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001417 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1418 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1419 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001420 }
1421
1422 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001423 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1424 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1425 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001426 }
1427
1428 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001429 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1430 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001431 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1432 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1433 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001434 }
1435
1436 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001437 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1438 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1439 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001440 }
1441 }
1442
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001443 if ((0 != ext_fmt_android->externalFormat) &&
1444 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001445 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001446 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1447 ") which has "
1448 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1449 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001450 }
1451 }
1452
Dave Houltond9611312018-11-19 17:03:36 -07001453 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001454 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001455 skip |=
1456 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1457 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1458 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001459 }
1460 }
1461
1462 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1463 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1464 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001465 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001466 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1467 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1468 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1469 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001470 }
1471
1472 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001473 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1474 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1475 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1476 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1477 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001478 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001479 }
1480
1481 return skip;
1482}
1483
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001484bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001485 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001486 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001487
1488 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001489 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001490 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1491 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001492 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001493 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001494 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001495
Dave Houltond9611312018-11-19 17:03:36 -07001496 // Chain must include a compatible ycbcr conversion
1497 bool conv_found = false;
1498 uint64_t external_format = 0;
1499 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1500 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001501 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001502 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001503 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001504 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001505 }
Dave Houltond9611312018-11-19 17:03:36 -07001506 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001507 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001508 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001509 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1510 "an externalFormat (%" PRIu64
1511 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1512 "with the same external format.",
1513 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001514 }
1515
1516 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001517 if (IsIdentitySwizzle(create_info->components) == false) {
1518 skip |= LogError(
1519 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1520 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1521 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1522 "= %s.",
1523 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1524 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001525 }
1526 }
Dave Houltond9611312018-11-19 17:03:36 -07001527
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001528 return skip;
1529}
1530
John Zulaufa26d3c82019-08-14 16:09:08 -06001531bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001532 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001533
John Zulaufa26d3c82019-08-14 16:09:08 -06001534 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001535 if (image_state != nullptr) {
1536 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1537 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1538 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1539 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1540 "bound to memory.");
1541 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001542 }
1543 return skip;
1544}
1545
1546#else
1547
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001548bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001549 return false;
1550}
1551
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001552bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001553
John Zulaufa26d3c82019-08-14 16:09:08 -06001554bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001555
1556#endif // VK_USE_PLATFORM_ANDROID_KHR
1557
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001558bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1559 bool skip = false;
1560
1561 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1562 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1563 const VkImageTiling image_tiling = pCreateInfo->tiling;
1564 const VkFormat image_format = pCreateInfo->format;
1565
1566 if (image_format == VK_FORMAT_UNDEFINED) {
1567 // VU 01975 states format can't be undefined unless an android externalFormat
1568#ifdef VK_USE_PLATFORM_ANDROID_KHR
1569 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1570 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1571 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1572 if (it != ahb_ext_formats_map.end()) {
1573 tiling_features = it->second;
1574 }
1575 }
1576#endif
1577 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1578 uint64_t drm_format_modifier = 0;
1579 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1580 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1581 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1582 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1583
1584 if (drm_explicit != nullptr) {
1585 drm_format_modifier = drm_explicit->drmFormatModifier;
1586 } else {
1587 // VUID 02261 makes sure its only explict or implict in parameter checking
1588 assert(drm_implicit != nullptr);
1589 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1590 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1591 }
1592 }
1593
1594 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1595 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1596 nullptr};
1597 format_properties_2.pNext = (void *)&drm_properties_list;
1598 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001599 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1600 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1601 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1602 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001603
1604 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1605 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1606 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1607 }
1608 }
1609 } else {
1610 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1611 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1612 : format_properties.optimalTilingFeatures;
1613 }
1614
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001615 // Lack of disjoint format feature support while using the flag
1616 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1617 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1618 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1619 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1620 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1621 string_VkFormat(pCreateInfo->format));
1622 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001623
1624 return skip;
1625}
1626
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001627bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001628 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001629 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001630
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001631 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001632 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001633 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1634 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001635 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1636 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001637 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001638 }
1639
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001640 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1641 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001642 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1643 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1644 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001645 }
1646
1647 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001648 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1649 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1650 "height (%d) and arrayLayers (%d) must be >= 6.",
1651 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001652 }
Dave Houlton130c0212018-01-29 13:39:56 -07001653 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001654
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001655 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001656 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1657 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1658 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001659 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1660 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1661 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001662 }
1663
1664 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001665 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1666 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1667 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001668 }
1669
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001670 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
ByumjinConffx991b6062019-08-14 15:17:53 -07001671 uint32_t ceiling_width =
1672 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1673 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1674 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1675 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001676 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1677 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1678 "ceiling of device "
1679 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1680 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1681 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001682 }
1683
1684 uint32_t ceiling_height =
1685 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1686 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1687 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1688 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001689 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1690 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1691 "ceiling of device "
1692 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1693 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1694 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001695 }
1696 }
1697
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001698 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001699 VkResult result = VK_SUCCESS;
1700 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1701 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1702 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1703 &format_limits);
1704 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001705 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1706 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1707 if (modifier_list) {
1708 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1709 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1710 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1711 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1712 image_format_info.type = pCreateInfo->imageType;
1713 image_format_info.format = pCreateInfo->format;
1714 image_format_info.tiling = pCreateInfo->tiling;
1715 image_format_info.usage = pCreateInfo->usage;
1716 image_format_info.flags = pCreateInfo->flags;
1717 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1718
1719 result =
1720 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1721 format_limits = image_format_properties.imageFormatProperties;
1722
1723 /* The application gives a list of modifier and the driver
1724 * selects one. If one is wrong, stop there.
1725 */
1726 if (result != VK_SUCCESS) break;
1727 }
1728 } else if (explicit_modifier) {
1729 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1730 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1731 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1732 image_format_info.type = pCreateInfo->imageType;
1733 image_format_info.format = pCreateInfo->format;
1734 image_format_info.tiling = pCreateInfo->tiling;
1735 image_format_info.usage = pCreateInfo->usage;
1736 image_format_info.flags = pCreateInfo->flags;
1737 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1738
1739 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1740 format_limits = image_format_properties.imageFormatProperties;
1741 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001742 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001743
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001744 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1745 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1746 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1747 if (result != VK_SUCCESS) {
1748 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001749#ifdef VK_USE_PLATFORM_ANDROID_KHR
1750 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1751#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001752 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001753 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001754 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1755 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001756 } else {
1757 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1758 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001759 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1760 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1761 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001762 }
Dave Houlton130c0212018-01-29 13:39:56 -07001763
Dave Houltona585d132019-01-18 13:05:42 -07001764 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1765 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1766 (uint64_t)pCreateInfo->samples;
1767 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001768
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001769 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001770 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001771 uint64_t ig_mask = imageGranularity - 1;
1772 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001773
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001774 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001775 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1776 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1777 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1778 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001779 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001780
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001781 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001782 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1783 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1784 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001785 }
1786
1787 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001788 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1789 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1790 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001791 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001792
1793 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1794 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1795 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1796 pCreateInfo->extent.width, format_limits.maxExtent.width);
1797 }
1798
1799 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1800 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1801 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1802 pCreateInfo->extent.height, format_limits.maxExtent.height);
1803 }
1804
1805 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1806 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1807 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1808 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1809 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001810 }
1811
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001812 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001813 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1814 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1815 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1816 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001817 skip |= LogError(device, error_vuid,
1818 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1819 "YCbCr Conversion format, arrayLayers must be 1",
1820 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001821 }
1822
1823 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001824 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1825 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1826 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001827 }
1828
1829 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001830 skip |= LogError(
1831 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001832 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1833 string_VkSampleCountFlagBits(pCreateInfo->samples));
1834 }
1835
1836 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001837 skip |= LogError(
1838 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001839 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1840 string_VkImageType(pCreateInfo->imageType));
1841 }
1842 }
1843
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001844 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001845 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001846 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001847 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001848 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1849 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1850 "format must be block, ETC or ASTC compressed, but is %s",
1851 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001852 }
1853 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001854 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1855 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1856 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001857 }
1858 }
1859 }
1860
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001861 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001862 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1863 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
1864 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001865 }
1866
unknown2c877272019-07-11 12:56:50 -06001867 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1868 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1869 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001870 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1871 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1872 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001873 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001874
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001875 const auto swapchain_create_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1876 if (swapchain_create_info != nullptr) {
1877 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1878 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1879 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1880
1881 // Validate rest of Swapchain Image create check that require swapchain state
1882 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1883 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1884 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1885 skip |= LogError(
1886 device, vuid,
1887 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1888 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1889 }
1890 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1891 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1892 skip |= LogError(device, vuid,
1893 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1894 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1895 }
1896 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR);
1897 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1898 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1899 skip |= LogError(device, vuid,
1900 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1901 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
1902 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR flags both set.");
1903 }
1904 }
1905 }
1906
sfricke-samsungedce77a2020-07-03 22:35:13 -07001907 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1908 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1909 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1910 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1911 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1912 }
1913 const VkImageCreateFlags invalid_flags =
1914 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1915 if ((pCreateInfo->flags & invalid_flags) != 0) {
1916 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1917 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1918 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1919 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1920 }
1921 }
1922
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001923 skip |= ValidateImageFormatFeatures(pCreateInfo);
1924
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001925 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001926}
1927
John Zulauf7eeb6f72019-06-17 11:56:36 -06001928void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1929 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1930 if (VK_SUCCESS != result) return;
1931
1932 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001933 auto image_state = Get<IMAGE_STATE>(*pImage);
1934 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001935}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001936
Jeff Bolz5c801d12019-10-09 10:38:45 -05001937bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001938 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001939 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001940 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001941 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001942 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001943 }
1944 return skip;
1945}
1946
John Zulauf7eeb6f72019-06-17 11:56:36 -06001947void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1948 // Clean up validation specific data
1949 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001950
locke-lunargcba7d5f2019-12-30 16:59:11 -07001951 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001952
1953 // Clean up generic image state
1954 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001955}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001956
sfricke-samsungcd924d92020-05-20 23:51:17 -07001957bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
1958 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001959 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07001960 const VkImage image = image_state->image;
1961 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001962
1963 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001964 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
1965 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001966 }
1967
sfricke-samsungcd924d92020-05-20 23:51:17 -07001968 if (FormatIsDepthOrStencil(format)) {
1969 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1970 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
1971 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
1972 } else if (FormatIsCompressed(format)) {
1973 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1974 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
1975 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001976 }
1977
1978 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001979 skip |=
1980 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
1981 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
1982 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001983 }
1984 return skip;
1985}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001986
John Zulauf07288512019-07-05 11:09:50 -06001987bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1988 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1989 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001990 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001991 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1992 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001993 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
1994 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1995 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001996 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001997
1998 } else {
1999 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2000 if (!device_extensions.vk_khr_shared_presentable_image) {
2001 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002002 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2003 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2004 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002005 }
2006 } else {
2007 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2008 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002009 skip |= LogError(
2010 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002011 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2012 func_name, string_VkImageLayout(dest_image_layout));
2013 }
2014 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002015 }
2016
John Zulauff660ad62019-03-23 07:16:05 -06002017 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002018 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002019 if (subresource_map) {
2020 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002021 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002022 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07002023 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
2024 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002025 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2026 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2027 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2028 } else {
2029 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002030 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002031 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2032 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2033 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2034 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002035 }
John Zulauf5e617452019-11-19 14:44:16 -07002036 }
John Zulauff660ad62019-03-23 07:16:05 -06002037 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002038 }
2039
2040 return skip;
2041}
2042
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002043bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2044 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002045 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002046 bool skip = false;
2047 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002048 const auto *cb_node = GetCBState(commandBuffer);
2049 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002050 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002051 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002052 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002053 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002054 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002055 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002056 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2057 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002058 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002059 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002060 skip |=
2061 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2062 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2063 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002064 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002065 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002066 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002067 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002068 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002069 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002070 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2071 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2072 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2073 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2074 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2075 string_VkFormat(image_state->createInfo.format));
2076 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002077 }
2078 return skip;
2079}
2080
John Zulaufeabb4462019-07-05 14:13:03 -06002081void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2082 const VkClearColorValue *pColor, uint32_t rangeCount,
2083 const VkImageSubresourceRange *pRanges) {
2084 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2085
2086 auto cb_node = GetCBState(commandBuffer);
2087 auto image_state = GetImageState(image);
2088 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002089 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002090 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002091 }
2092 }
2093}
2094
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002095bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2096 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002097 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002098 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002099
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002100 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002101 const auto *cb_node = GetCBState(commandBuffer);
2102 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002103 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002104 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002105 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002106 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002107 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002108 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002109 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002110 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002111 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002112 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002113 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002114 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002115 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2116 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2117 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2118 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002119
2120 bool any_include_aspect_depth_bit = false;
2121 bool any_include_aspect_stencil_bit = false;
2122
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002123 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002124 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002125 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002126 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002127 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002128 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2129 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002130 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2131 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2132 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2133 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002134 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002135 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2136 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002137 if (FormatHasDepth(image_format) == false) {
2138 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2139 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2140 "doesn't have a depth component.",
2141 i, string_VkFormat(image_format));
2142 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002143 }
2144 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2145 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002146 if (FormatHasStencil(image_format) == false) {
2147 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2148 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2149 "%s doesn't have a stencil component.",
2150 i, string_VkFormat(image_format));
2151 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002152 }
2153 }
2154 if (any_include_aspect_stencil_bit) {
2155 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2156 if (image_stencil_struct != nullptr) {
2157 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2158 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002159 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2160 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2161 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2162 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002163 }
2164 } else {
2165 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002166 skip |= LogError(
2167 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002168 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2169 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2170 "in VkImageCreateInfo::usage used to create image");
2171 }
2172 }
2173 }
2174 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002175 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2176 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2177 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002178 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002179 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002180 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2181 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002182 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002183 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002184 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002185 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2186 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2187 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2188 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002189 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002190 }
2191 return skip;
2192}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002193
John Zulaufeabb4462019-07-05 14:13:03 -06002194void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2195 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2196 const VkImageSubresourceRange *pRanges) {
2197 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2198 auto cb_node = GetCBState(commandBuffer);
2199 auto image_state = GetImageState(image);
2200 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002201 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002202 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002203 }
2204 }
2205}
2206
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002207// Returns true if [x, xoffset] and [y, yoffset] overlap
2208static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2209 bool result = false;
2210 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2211 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2212
2213 if (intersection_max > intersection_min) {
2214 result = true;
2215 }
2216 return result;
2217}
2218
Dave Houltonc991cc92018-03-06 11:08:51 -07002219// Returns true if source area of first copy region intersects dest area of second region
2220// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
2221static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002222 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002223
Dave Houltonc991cc92018-03-06 11:08:51 -07002224 // Separate planes within a multiplane image cannot intersect
2225 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002226 return result;
2227 }
2228
Dave Houltonc991cc92018-03-06 11:08:51 -07002229 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2230 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2231 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002232 result = true;
2233 switch (type) {
2234 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002235 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002236 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002237 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002238 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002239 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002240 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002241 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002242 break;
2243 default:
2244 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2245 assert(false);
2246 }
2247 }
2248 return result;
2249}
2250
Dave Houltonfc1a4052017-04-27 14:32:45 -06002251// Returns non-zero if offset and extent exceed image extents
2252static const uint32_t x_bit = 1;
2253static const uint32_t y_bit = 2;
2254static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002255static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002256 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002257 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002258 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2259 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002260 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002261 }
2262 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2263 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002264 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002265 }
2266 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2267 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002268 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002269 }
2270 return result;
2271}
2272
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002273// Test if two VkExtent3D structs are equivalent
2274static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2275 bool result = true;
2276 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2277 (extent->depth != other_extent->depth)) {
2278 result = false;
2279 }
2280 return result;
2281}
2282
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002283// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002284static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002285 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2286}
2287
2288// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002289VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002290 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2291 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002292 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002293 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002294 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002295 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002296 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002297 granularity.width *= block_size.width;
2298 granularity.height *= block_size.height;
2299 }
2300 }
2301 return granularity;
2302}
2303
2304// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2305static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2306 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002307 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2308 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002309 valid = false;
2310 }
2311 return valid;
2312}
2313
2314// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002315bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002316 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002317 bool skip = false;
2318 VkExtent3D offset_extent = {};
2319 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2320 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2321 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
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 offset must always be (0, 0, 0)
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002324 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002325 skip |= LogError(cb_node->commandBuffer, vuid,
2326 "%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 "
2327 "image transfer granularity is (w=0, h=0, d=0).",
2328 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002329 }
2330 } else {
2331 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2332 // integer multiples of the image transfer granularity.
2333 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002334 skip |= LogError(cb_node->commandBuffer, vuid,
2335 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2336 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2337 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2338 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002339 }
2340 }
2341 return skip;
2342}
2343
2344// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002345bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002346 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002347 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002348 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002349 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002350 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2351 // subresource extent.
2352 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002353 skip |= LogError(cb_node->commandBuffer, vuid,
2354 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2355 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2356 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2357 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002358 }
2359 } else {
2360 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2361 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2362 // subresource extent dimensions.
2363 VkExtent3D offset_extent_sum = {};
2364 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2365 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2366 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002367 bool x_ok = true;
2368 bool y_ok = true;
2369 bool z_ok = true;
2370 switch (image_type) {
2371 case VK_IMAGE_TYPE_3D:
2372 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2373 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002374 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002375 case VK_IMAGE_TYPE_2D:
2376 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2377 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002378 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002379 case VK_IMAGE_TYPE_1D:
2380 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2381 (subresource_extent->width == offset_extent_sum.width));
2382 break;
2383 default:
2384 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2385 assert(false);
2386 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002387 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002388 skip |=
2389 LogError(cb_node->commandBuffer, vuid,
2390 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2391 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2392 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2393 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2394 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2395 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002396 }
2397 }
2398 return skip;
2399}
2400
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002401bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002402 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002403 bool skip = false;
2404 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002405 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2406 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002407 }
2408 return skip;
2409}
2410
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002411bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002412 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002413 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002414 bool skip = false;
2415 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2416 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002417 skip |= LogError(cb_node->commandBuffer, vuid,
2418 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2419 "%u, but provided %s has %u array layers.",
2420 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2421 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002422 }
2423 return skip;
2424}
2425
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002426// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002427bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002428 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002429 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002430 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002431 VkExtent3D granularity = GetScaledItg(cb_node, img);
2432 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002433 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002434 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002435 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002436 return skip;
2437}
2438
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002439// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002440bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002441 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002442 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002443 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002444 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002445 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2446 skip |=
2447 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002448 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002449 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002450 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2451 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002452
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002453 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002454 granularity = GetScaledItg(cb_node, dst_img);
2455 skip |=
2456 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002457 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002458 const VkExtent3D dest_effective_extent =
2459 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002460 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002461 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002462 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002463 return skip;
2464}
2465
Dave Houlton6f9059e2017-05-02 17:15:13 -06002466// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002467bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002468 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002469 bool skip = false;
2470
2471 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002472 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002473
2474 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002475 const VkExtent3D src_copy_extent = region.extent;
2476 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002477 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2478
Dave Houlton6f9059e2017-05-02 17:15:13 -06002479 bool slice_override = false;
2480 uint32_t depth_slices = 0;
2481
2482 // Special case for copying between a 1D/2D array and a 3D image
2483 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2484 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002485 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002486 slice_override = (depth_slices != 1);
2487 } 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 -07002488 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002489 slice_override = (depth_slices != 1);
2490 }
2491
2492 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002493 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002494 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002495 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002496 LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-00146",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002497 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2498 "be 0 and 1, respectively.",
2499 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002500 }
2501 }
2502
Dave Houlton533be9f2018-03-26 17:08:30 -06002503 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 -06002504 skip |= LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-01785",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002505 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
2506 "these must be 0 and 1, respectively.",
2507 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002508 }
2509
Dave Houlton533be9f2018-03-26 17:08:30 -06002510 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002511 skip |= LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-01787",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002512 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2513 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002514 }
2515
Dave Houltonc991cc92018-03-06 11:08:51 -07002516 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002517 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002518 if (FormatIsCompressed(src_state->createInfo.format) ||
2519 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002520 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002521 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002522 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2523 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2524 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002525 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002526 skip |= LogError(src_state->image, vuid,
2527 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
2528 "texel width & height (%d, %d).",
2529 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002530 }
2531
Dave Houlton94a00372017-12-14 15:08:47 -07002532 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002533 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2534 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002535 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002536 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002537 LogError(src_state->image, vuid,
2538 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2539 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2540 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002541 }
2542
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002543 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002544 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2545 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002546 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002547 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002548 LogError(src_state->image, vuid,
2549 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2550 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2551 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002552 }
2553
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002554 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002555 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2556 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002557 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002558 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002559 LogError(src_state->image, vuid,
2560 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2561 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2562 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002563 }
2564 } // Compressed
2565
2566 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002567 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002568 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002569 skip |= LogError(dst_state->image, "VUID-vkCmdCopyImage-dstImage-00152",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002570 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
2571 "these must be 0 and 1, respectively.",
2572 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002573 }
2574 }
2575
Dave Houlton533be9f2018-03-26 17:08:30 -06002576 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 -07002577 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002578 LogError(dst_state->image, "VUID-vkCmdCopyImage-dstImage-01786",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002579 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2580 "and 1, respectively.",
2581 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002582 }
2583
Dave Houlton533be9f2018-03-26 17:08:30 -06002584 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002585 skip |= LogError(dst_state->image, "VUID-vkCmdCopyImage-dstImage-01788",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002586 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2587 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002588 }
2589
sfricke-samsung30b094c2020-05-30 11:42:11 -07002590 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002591 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002592 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2593 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
2594 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002595 LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-04443",
sfricke-samsung30b094c2020-05-30 11:42:11 -07002596 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2597 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2598 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2599 }
2600 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002601 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002602 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002603 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002604 LogError(dst_state->image, "VUID-vkCmdCopyImage-dstImage-04444",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002605 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2606 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2607 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002608 }
2609 }
2610 } else { // Pre maint 1
2611 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002612 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002613 skip |= LogError(src_state->image, "VUID-vkCmdCopyImage-srcImage-00139",
sfricke-samsung30b094c2020-05-30 11:42:11 -07002614 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2615 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2616 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2617 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
2618 }
Dave Houltonee281a52017-12-08 13:51:02 -07002619 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002620 skip |= LogError(dst_state->image, "VUID-vkCmdCopyImage-srcImage-00139",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002621 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2622 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2623 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2624 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002625 }
2626 }
2627 }
2628
Dave Houltonc991cc92018-03-06 11:08:51 -07002629 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2630 if (FormatIsCompressed(dst_state->createInfo.format) ||
2631 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002632 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002633
2634 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002635 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2636 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2637 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002638 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002639 skip |= LogError(dst_state->image, vuid,
2640 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
2641 "texel width & height (%d, %d).",
2642 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002643 }
2644
Dave Houlton94a00372017-12-14 15:08:47 -07002645 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002646 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2647 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002648 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002649 skip |= LogError(
2650 dst_state->image, vuid,
2651 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2652 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2653 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002654 }
2655
Dave Houltonee281a52017-12-08 13:51:02 -07002656 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2657 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2658 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002659 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002660 skip |= LogError(dst_state->image, vuid,
2661 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2662 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2663 "height (%d).",
2664 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002665 }
2666
Dave Houltonee281a52017-12-08 13:51:02 -07002667 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2668 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2669 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002670 const char *vuid = ext_ycbcr ? "VUID-vkCmdCopyImage-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002671 skip |= LogError(
2672 dst_state->image, vuid,
2673 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2674 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2675 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002676 }
2677 } // Compressed
2678 }
2679 return skip;
2680}
2681
Dave Houltonc991cc92018-03-06 11:08:51 -07002682// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002683bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002684 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002685 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002686
2687 // Neither image is multiplane
2688 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2689 // If neither image is multi-plane the aspectMask member of src and dst must match
2690 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2691 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002692 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002693 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002694 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002695 }
2696 } else {
2697 // Source image multiplane checks
2698 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2699 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2700 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2701 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002702 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002703 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002704 }
2705 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2706 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2707 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002708 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002709 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002710 }
2711 // Single-plane to multi-plane
2712 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2713 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2714 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002715 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002716 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002717 }
2718
2719 // Dest image multiplane checks
2720 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2721 aspect = region.dstSubresource.aspectMask;
2722 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2723 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002724 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002725 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002726 }
2727 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2728 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2729 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002730 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002731 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002732 }
2733 // Multi-plane to single-plane
2734 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2735 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2736 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002737 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002738 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002739 }
2740 }
2741
2742 return skip;
2743}
2744
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002745bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2746 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002747 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002748 const auto *cb_node = GetCBState(commandBuffer);
2749 const auto *src_image_state = GetImageState(srcImage);
2750 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002751 const VkFormat src_format = src_image_state->createInfo.format;
2752 const VkFormat dst_format = dst_image_state->createInfo.format;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002753 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002754
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002755 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002756
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002757 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2758
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002759 for (uint32_t i = 0; i < regionCount; i++) {
2760 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002761
2762 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2763 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002764 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002765
Dave Houlton6f9059e2017-05-02 17:15:13 -06002766 bool slice_override = false;
2767 uint32_t depth_slices = 0;
2768
2769 // Special case for copying between a 1D/2D array and a 3D image
2770 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2771 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2772 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002773 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002774 slice_override = (depth_slices != 1);
2775 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2776 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002777 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002778 slice_override = (depth_slices != 1);
2779 }
2780
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002781 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2782 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2783 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002784 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002785 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002786 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002787 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002788 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2789 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002790 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002791 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2792 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002793
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002794 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002795 // No chance of mismatch if we're overriding depth slice count
2796 if (!slice_override) {
2797 // The number of depth slices in srcSubresource and dstSubresource must match
2798 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2799 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002800 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2801 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002802 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002803 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2804 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002805 if (src_slices != dst_slices) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002806 skip |= LogError(command_buffer, "VUID-VkImageCopy-extent-00140",
2807 "vkCmdCopyImage(): number of depth slices in source and destination subresources for "
2808 "pRegions[%u] do not match.",
2809 i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002810 }
2811 }
2812 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002813 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002814 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002815 skip |= LogError(
2816 command_buffer, "VUID-VkImageCopy-layerCount-00138",
2817 "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[%u] do not match", i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002818 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002819 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002820
Dave Houltonc991cc92018-03-06 11:08:51 -07002821 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002822 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002823 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002824 }
2825
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002826 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002827 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2828 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002829 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002830 skip |= LogError(command_buffer, "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002831 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002832 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002833
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002834 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002835 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002836 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002837 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002838 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002839 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002840 }
2841
2842 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002843 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002844 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002845 ss << "vkCmdCopyImage(): pRegion[" << i
2846 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002847 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002848 }
2849
Dave Houltonfc1a4052017-04-27 14:32:45 -06002850 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002851 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2852 if (slice_override) src_copy_extent.depth = depth_slices;
2853 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002854 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002855 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002856 LogError(command_buffer, "VUID-vkCmdCopyImage-srcOffset-00144",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002857 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2858 "width [%1d].",
2859 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002860 }
2861
2862 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002863 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002864 LogError(command_buffer, "VUID-vkCmdCopyImage-srcOffset-00145",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002865 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2866 "height [%1d].",
2867 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002868 }
2869 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002870 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002871 LogError(command_buffer, "VUID-vkCmdCopyImage-srcOffset-00147",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002872 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2873 "depth [%1d].",
2874 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002875 }
2876
Dave Houltonee281a52017-12-08 13:51:02 -07002877 // Adjust dest extent if necessary
2878 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2879 if (slice_override) dst_copy_extent.depth = depth_slices;
2880
2881 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002882 if (extent_check & x_bit) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002883 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstOffset-00150",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002884 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2885 "width [%1d].",
2886 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002887 }
2888 if (extent_check & y_bit) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002889 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstOffset-00151",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002890 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2891 "height [%1d].",
2892 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002893 }
2894 if (extent_check & z_bit) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002895 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstOffset-00153",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002896 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2897 "depth [%1d].",
2898 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002899 }
2900
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002901 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2902 // must not overlap in memory
2903 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002904 for (uint32_t j = 0; j < regionCount; j++) {
2905 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002906 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002907 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002908 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002909 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002910 }
2911 }
2912 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002913
2914 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2915 if (device_extensions.vk_khr_maintenance1) {
2916 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2917 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2918 (src_copy_extent.depth != 1)) {
2919 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002920 command_buffer, "VUID-vkCmdCopyImage-srcImage-01790",
sfricke-samsung48172ca2020-02-13 23:38:11 -08002921 "vkCmdCopyImage(): pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1", i,
2922 src_copy_extent.depth);
2923 }
2924 } else {
2925 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2926 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2927 (src_copy_extent.depth != 1)) {
2928 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002929 command_buffer, "VUID-vkCmdCopyImage-srcImage-01789",
sfricke-samsung48172ca2020-02-13 23:38:11 -08002930 "vkCmdCopyImage(): pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1", i,
2931 src_copy_extent.depth);
2932 }
2933 }
2934
2935 // Check if 2D with 3D and depth not equal to 2D layerCount
2936 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2937 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2938 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002939 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-01791",
sfricke-samsung48172ca2020-02-13 23:38:11 -08002940 "vkCmdCopyImage(): pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
2941 "srcSubresource.layerCount (%u)",
2942 i, src_copy_extent.depth, region.srcSubresource.layerCount);
2943 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2944 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
2945 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06002946 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-dstImage-01792",
sfricke-samsung48172ca2020-02-13 23:38:11 -08002947 "vkCmdCopyImage(): pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
2948 "dstSubresource.layerCount (%u)",
2949 i, src_copy_extent.depth, region.dstSubresource.layerCount);
2950 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002951
2952 // Check for multi-plane format compatiblity
2953 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
2954 size_t src_format_size = 0;
2955 size_t dst_format_size = 0;
2956 if (FormatIsMultiplane(src_format)) {
2957 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
2958 src_format_size = FormatElementSize(planeFormat);
2959 } else {
2960 src_format_size = FormatElementSize(src_format);
2961 }
2962 if (FormatIsMultiplane(dst_format)) {
2963 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
2964 dst_format_size = FormatElementSize(planeFormat);
2965 } else {
2966 dst_format_size = FormatElementSize(dst_format);
2967 }
2968 // If size is still zero, then format is invalid and will be caught in another VU
2969 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
2970 skip |=
2971 LogError(command_buffer, "VUID-vkCmdCopyImage-None-01549",
2972 "vkCmdCopyImage(): pRegions[%u] called with non-compatible image formats. "
2973 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
2974 i, string_VkFormat(src_format), string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(),
2975 string_VkFormat(dst_format), string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
2976 }
2977 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002978 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002979
sfricke-samsung99dc12c2020-04-23 01:52:01 -07002980 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
2981 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
2982 // because because both texels are 4 bytes in size.
2983 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
2984 const char *compatible_vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyImage-srcImage-01548"
2985 : "VUID-vkCmdCopyImage-srcImage-00135";
2986 // Depth/stencil formats must match exactly.
2987 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
2988 if (src_format != dst_format) {
2989 skip |= LogError(command_buffer, compatible_vuid,
2990 "vkCmdCopyImage(): Depth/stencil formats must match exactly for src (%s) and dst (%s).",
2991 string_VkFormat(src_format), string_VkFormat(dst_format));
2992 }
2993 } else {
2994 if (!FormatSizesAreEqual(src_format, dst_format, regionCount, pRegions)) {
2995 skip |= LogError(command_buffer, compatible_vuid,
2996 "vkCmdCopyImage(): Unmatched image format sizes. "
2997 "The src format %s has size of %zu and dst format %s has size of %zu.",
2998 string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
2999 FormatElementSize(dst_format));
3000 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003001 }
3002 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003003
Dave Houlton33c22b72017-02-28 13:16:02 -07003004 // Source and dest image sample counts must match
3005 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
3006 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003007 skip |= LogError(command_buffer, "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07003008 }
3009
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003010 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
3011 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003012 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003013 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
3014 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3015 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
3016 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
sfricke-samsung022fa252020-07-24 03:26:16 -07003017 skip |= ValidateProtectedImage(cb_node, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-commandBuffer-01825");
3018 skip |= ValidateProtectedImage(cb_node, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-commandBuffer-01826");
3019 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-commandBuffer-01827");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003020
3021 // Validation for VK_EXT_fragment_density_map
3022 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3023 skip |= LogError(
3024 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
3025 "vkCmdCopyImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3026 }
3027 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3028 skip |= LogError(
3029 command_buffer, "VUID-vkCmdCopyImage-dstImage-02542",
3030 "vkCmdCopyImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3031 }
3032
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003033 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003034 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003035 "VUID-vkCmdCopyImage-srcImage-01995");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003036 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003037 "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04003038 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003039 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003040 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003041 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
3042 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06003043 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003044 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3045 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
3046 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
3047 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3048 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
3049 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003050 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003051 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003052 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
3053 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003054 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003055 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
3056 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003057 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
3058 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003059 }
3060
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003061 return skip;
3062}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003063
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003064void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3065 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3066 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003067 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3068 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003069 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003070 auto src_image_state = GetImageState(srcImage);
3071 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003072
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003073 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003074 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003075 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3076 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003077 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003078}
3079
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003080// Returns true if sub_rect is entirely contained within rect
3081static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3082 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
3083 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
3084 return false;
3085 return true;
3086}
3087
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003088bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003089 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
3090 const VkRect2D &render_area, uint32_t rect_count,
3091 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003092 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003093 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3094 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06003095 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07003096 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003097
3098 for (uint32_t j = 0; j < rect_count; j++) {
3099 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003100 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3101 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3102 "the current render pass instance.",
3103 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003104 }
3105
3106 if (image_view_state) {
3107 // The layers specified by a given element of pRects must be contained within every attachment that
3108 // pAttachments refers to
3109 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3110 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3111 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003112 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3113 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3114 "of pAttachment[%d].",
3115 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003116 }
3117 }
3118 }
3119 return skip;
3120}
3121
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003122bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3123 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003124 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003125 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003126 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003127 if (!cb_node) return skip;
3128
3129 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3130 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3131 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003132 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003133
3134 // Validate that attachment is in reference list of active subpass
3135 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003136 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003137 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003138 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003139 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003140 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003141
John Zulauf3a548ef2019-02-01 16:14:07 -07003142 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3143 auto clear_desc = &pAttachments[attachment_index];
3144 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003145
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003146 if (0 == clear_desc->aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003147 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003148 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003149 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003150 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003151 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3152 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3153 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3154 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003155 skip |= LogError(
3156 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3157 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3158 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3159 attachment_index, clear_desc->colorAttachment,
3160 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3161 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003162
John Zulauff2582972019-02-09 14:53:30 -07003163 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3164 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003165 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003166 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3167 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3168 " subpass %u. colorAttachmentCount=%u",
3169 attachment_index, clear_desc->colorAttachment,
3170 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3171 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003172 }
John Zulauff2582972019-02-09 14:53:30 -07003173 fb_attachment = color_attachment;
3174
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003175 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3176 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3177 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003178 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003179 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003180 }
3181 } else { // Must be depth and/or stencil
3182 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
3183 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003184 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003185 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-parameter", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003186 }
3187 if (!subpass_desc->pDepthStencilAttachment ||
3188 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003189 skip |= LogPerformanceWarning(
3190 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003191 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003192 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003193 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003194 }
3195 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003196 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003197 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3198 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003199 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003200
3201 // Once the framebuffer attachment is found, can get the image view state
3202 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3203 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3204 const IMAGE_VIEW_STATE *image_view_state =
3205 GetAttachmentImageViewState(GetCBState(commandBuffer), framebuffer, fb_attachment);
3206 if (image_view_state != nullptr) {
3207 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3208 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3209 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3210 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3211 }
3212 }
John Zulauf441558b2019-08-12 11:47:39 -06003213 }
3214 }
3215 return skip;
3216}
3217
3218void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3219 const VkClearAttachment *pAttachments, uint32_t rectCount,
3220 const VkClearRect *pRects) {
3221 auto *cb_node = GetCBState(commandBuffer);
3222 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3223 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3224 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3225 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3226 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3227 const auto clear_desc = &pAttachments[attachment_index];
3228 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3229 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3230 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3231 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3232 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3233 subpass_desc->pDepthStencilAttachment) {
3234 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3235 }
3236 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003237 if (!clear_rect_copy) {
3238 // We need a copy of the clear rectangles that will persist until the last lambda executes
3239 // but we want to create it as lazily as possible
3240 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003241 }
John Zulauf441558b2019-08-12 11:47:39 -06003242 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3243 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003244 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003245 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003246 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003247 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3248 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003249 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
3250 clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003251 return skip;
3252 };
3253 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003254 }
3255 }
3256 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003257}
3258
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003259bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3260 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003261 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003262 const auto *cb_node = GetCBState(commandBuffer);
3263 const auto *src_image_state = GetImageState(srcImage);
3264 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003265
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003266 bool skip = false;
3267 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003268 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3269 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003270 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003271 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003272 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3273 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003274 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003275 "VUID-vkCmdResolveImage-dstImage-02003");
sfricke-samsung022fa252020-07-24 03:26:16 -07003276 skip |=
3277 ValidateProtectedImage(cb_node, src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-commandBuffer-01837");
3278 skip |=
3279 ValidateProtectedImage(cb_node, dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-commandBuffer-01838");
3280 skip |=
3281 ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-commandBuffer-01839");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003282
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003283 // Validation for VK_EXT_fragment_density_map
3284 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3285 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3286 "vkCmdResolveImage(): srcImage must not have been created with flags containing "
3287 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3288 }
3289 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3290 skip |= LogError(cb_node->commandBuffer, "vkCmdResolveImage-dstImage-02546",
3291 "vkCmdResolveImage(): dstImage must not have been created with flags containing "
3292 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3293 }
3294
Cort Stratton7df30962018-05-17 19:45:57 -07003295 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003296 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003297 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003298 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3299 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3300 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003301 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003302 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3303 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003304 // For each region, the number of layers in the image subresource should not be zero
3305 // For each region, src and dest image aspect must be color only
3306 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003307 const VkImageResolve region = pRegions[i];
3308 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3309 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003310 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, "vkCmdResolveImage()", "srcSubresource", i);
3311 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, "vkCmdResolveImage()", "dstSubresource", i);
3312 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003313 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3314 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003315 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003316 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3317 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003318 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003319 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003320 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, "vkCmdResolveImage()",
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003321 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003322 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
3323 src_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003324 "VUID-vkCmdResolveImage-srcSubresource-01711");
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003325 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
3326 dst_subresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
Cort Strattonff1542a2018-05-27 10:49:28 -07003327 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003328
3329 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003330 if (src_subresource.layerCount != dst_subresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003331 skip |= LogError(
3332 cb_node->commandBuffer, "VUID-VkImageResolve-layerCount-00267",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003333 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%u] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003334 }
Cort Stratton7df30962018-05-17 19:45:57 -07003335 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003336 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3337 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3338 skip |= LogError(
3339 cb_node->commandBuffer, "VUID-VkImageResolve-aspectMask-00266",
3340 "vkCmdResolveImage(): src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3341 i);
3342 }
3343
3344 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3345 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3346
3347 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003348 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003349 LogObjectList objlist(cb_node->commandBuffer);
3350 objlist.add(src_image_state->image);
3351 objlist.add(dst_image_state->image);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003352 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcImage-04446",
3353 "vkCmdResolveImage(): pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
3354 "subresources if the src or dst image is 3D.",
3355 i);
3356 }
3357 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3358 LogObjectList objlist(cb_node->commandBuffer);
3359 objlist.add(src_image_state->image);
3360 objlist.add(dst_image_state->image);
3361 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcImage-04447",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003362 "vkCmdResolveImage(): pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
3363 "subresources if the src or dst image is 3D.",
3364 i);
3365 }
3366 }
3367
3368 if (VK_IMAGE_TYPE_1D == src_image_type) {
3369 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3370 LogObjectList objlist(cb_node->commandBuffer);
3371 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003372 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcImage-00271",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003373 "vkCmdResolveImage(): srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
3374 "extent.height (%u) is not 1.",
3375 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.y,
3376 pRegions[i].extent.height);
3377 }
3378 }
3379 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3380 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3381 LogObjectList objlist(cb_node->commandBuffer);
3382 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003383 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcImage-00273",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003384 "vkCmdResolveImage(): srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
3385 "extent.depth (%u) is not 1.",
3386 report_data->FormatHandle(src_image_state->image).c_str(), i, pRegions[i].srcOffset.z,
3387 pRegions[i].extent.depth);
3388 }
3389 }
3390
3391 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3392 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3393 LogObjectList objlist(cb_node->commandBuffer);
3394 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003395 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstImage-00276",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003396 "vkCmdResolveImage(): dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
3397 "extent.height (%u) is not 1.",
3398 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.y,
3399 pRegions[i].extent.height);
3400 }
3401 }
3402 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3403 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3404 LogObjectList objlist(cb_node->commandBuffer);
3405 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003406 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstImage-00278",
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003407 "vkCmdResolveImage(): dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
3408 "extent.depth (%u) is not 1.",
3409 report_data->FormatHandle(dst_image_state->image).c_str(), i, pRegions[i].dstOffset.z,
3410 pRegions[i].extent.depth);
3411 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003412 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003413
3414 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3415 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3416 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3417 // developer
3418 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3419 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
3420 if ((extent_check & x_bit) != 0) {
3421 LogObjectList objlist(cb_node->commandBuffer);
3422 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003423 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcOffset-00269",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003424 "vkCmdResolveImage(): srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
3425 "exceeds subResource width [%u].",
3426 report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
3427 region.extent.width, subresource_extent.width);
3428 }
3429
3430 if ((extent_check & y_bit) != 0) {
3431 LogObjectList objlist(cb_node->commandBuffer);
3432 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003433 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcOffset-00270",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003434 "vkCmdResolveImage(): srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
3435 "exceeds subResource height [%u].",
3436 report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
3437 region.extent.height, subresource_extent.height);
3438 }
3439
3440 if ((extent_check & z_bit) != 0) {
3441 LogObjectList objlist(cb_node->commandBuffer);
3442 objlist.add(src_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003443 skip |= LogError(objlist, "VUID-vkCmdResolveImage-srcOffset-00272",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003444 "vkCmdResolveImage(): srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
3445 "exceeds subResource depth [%u].",
3446 report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
3447 region.extent.depth, subresource_extent.depth);
3448 }
3449 }
3450
3451 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3452 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3453 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3454 // developer
3455 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3456 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
3457 if ((extent_check & x_bit) != 0) {
3458 LogObjectList objlist(cb_node->commandBuffer);
3459 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003460 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstOffset-00274",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003461 "vkCmdResolveImage(): dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
3462 "exceeds subResource width [%u].",
3463 report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
3464 region.extent.width, subresource_extent.width);
3465 }
3466
3467 if ((extent_check & y_bit) != 0) {
3468 LogObjectList objlist(cb_node->commandBuffer);
3469 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003470 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstOffset-00275",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003471 "vkCmdResolveImage(): dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
3472 "exceeds subResource height [%u].",
3473 report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
3474 region.extent.height, subresource_extent.height);
3475 }
3476
3477 if ((extent_check & z_bit) != 0) {
3478 LogObjectList objlist(cb_node->commandBuffer);
3479 objlist.add(dst_image_state->image);
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003480 skip |= LogError(objlist, "VUID-vkCmdResolveImage-dstOffset-00277",
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003481 "vkCmdResolveImage(): dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
3482 "exceeds subResource depth [%u].",
3483 report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
3484 region.extent.depth, subresource_extent.depth);
3485 }
3486 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003487 }
3488
3489 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003490 skip |=
3491 LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-01386",
3492 "vkCmdResolveImage(): srcImage format (%s) and dstImage format (%s) are not the same.",
3493 string_VkFormat(src_image_state->createInfo.format), string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003494 }
3495 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003496 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
3497 "vkCmdResolveImage(): srcImage type (%s) and dstImage type (%s) are not the same.",
3498 string_VkImageType(src_image_state->createInfo.imageType),
3499 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003500 }
3501 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003502 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-srcImage-00257",
3503 "vkCmdResolveImage(): srcImage sample count is VK_SAMPLE_COUNT_1_BIT.");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003504 }
3505 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003506 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdResolveImage-dstImage-00259",
3507 "vkCmdResolveImage(): dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3508 string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003509 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003510 } else {
3511 assert(0);
3512 }
3513 return skip;
3514}
3515
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003516bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3517 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003518 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003519 const auto *cb_node = GetCBState(commandBuffer);
3520 const auto *src_image_state = GetImageState(srcImage);
3521 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003522
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003523 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003524 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003525 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003526 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003527 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003528 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003529 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003530 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003531 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003532 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3533 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003534 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003535 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3536 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003537 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003538 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3539 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003540 skip |=
3541 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003542 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3543 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003544 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003545 "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003546 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003547 "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003548
sfricke-samsung022fa252020-07-24 03:26:16 -07003549 skip |= ValidateProtectedImage(cb_node, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-commandBuffer-01834");
3550 skip |= ValidateProtectedImage(cb_node, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-commandBuffer-01835");
3551 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-commandBuffer-01836");
3552
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003553 // Validation for VK_EXT_fragment_density_map
3554 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3555 skip |= LogError(
3556 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3557 "vkCmdBlitImage(): srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3558 }
3559 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
3560 skip |= LogError(
3561 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-02545",
3562 "vkCmdBlitImage(): dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
3563 }
3564
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003565 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003566
Dave Houlton33c2d252017-06-09 17:08:32 -06003567 VkFormat src_format = src_image_state->createInfo.format;
3568 VkFormat dst_format = dst_image_state->createInfo.format;
3569 VkImageType src_type = src_image_state->createInfo.imageType;
3570 VkImageType dst_type = dst_image_state->createInfo.imageType;
3571
Cort Stratton186b1a22018-05-01 20:18:06 -04003572 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003573 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003574 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003575 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003576 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07003577 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003578 }
3579
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003580 if (FormatRequiresYcbcrConversion(src_format)) {
3581 skip |= LogError(device, "VUID-vkCmdBlitImage-srcImage-01561",
3582 "vkCmdBlitImage(): srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
3583 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3584 string_VkFormat(src_format));
3585 }
3586
3587 if (FormatRequiresYcbcrConversion(dst_format)) {
3588 skip |= LogError(device, "VUID-vkCmdBlitImage-dstImage-01562",
3589 "vkCmdBlitImage(): dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
3590 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
3591 string_VkFormat(dst_format));
3592 }
3593
Dave Houlton33c2d252017-06-09 17:08:32 -06003594 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003595 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-filter-00237",
3596 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003597 }
3598
Dave Houlton33c2d252017-06-09 17:08:32 -06003599 // Validate consistency for unsigned formats
3600 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3601 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003602 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003603 << "the other one must also have unsigned integer format. "
3604 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003605 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003606 }
3607
3608 // Validate consistency for signed formats
3609 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3610 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003611 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003612 << "the other one must also have signed integer format. "
3613 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003614 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003615 }
3616
3617 // Validate filter for Depth/Stencil formats
3618 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3619 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003620 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003621 << "then filter must be VK_FILTER_NEAREST.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003622 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003623 }
3624
3625 // Validate aspect bits and formats for depth/stencil images
3626 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3627 if (src_format != dst_format) {
3628 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003629 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003630 << "stencil, the other one must have exactly the same format. "
3631 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3632 << string_VkFormat(dst_format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003633 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003634 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003635 } // Depth or Stencil
3636
3637 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003638 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003639 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003640 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3641 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3642 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003643 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003644 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3645 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003646 for (uint32_t i = 0; i < regionCount; i++) {
3647 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003648 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003649 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003650 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3651 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003652 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003653 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3654 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003655 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3656 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3657 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003658 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003659 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003660 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003661 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003662 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3663 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003664 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003665 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3666 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003667 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003668 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3669 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003670 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003671 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003672 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003673 }
Dave Houlton48989f32017-05-26 15:01:46 -06003674 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3675 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003676 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003677 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003678 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003679 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003680
3681 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003682 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003683 skip |= LogError(
3684 cb_node->commandBuffer, "VUID-VkImageBlit-layerCount-00239",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003685 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003686 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003687
Dave Houlton48989f32017-05-26 15:01:46 -06003688 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003689 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageBlit-aspectMask-00238",
3690 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003691 }
Dave Houlton48989f32017-05-26 15:01:46 -06003692
Dave Houlton33c2d252017-06-09 17:08:32 -06003693 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003694 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-aspectMask-00241",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003695 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
3696 "image format %s.",
3697 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003698 }
3699
3700 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003701 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003702 cb_node->commandBuffer, "VUID-vkCmdBlitImage-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003703 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3704 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003705 }
3706
Dave Houlton48989f32017-05-26 15:01:46 -06003707 // Validate source image offsets
3708 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003709 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003710 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003711 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003712 LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00245",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003713 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3714 "of (%1d, %1d). These must be (0, 1).",
3715 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003716 }
3717 }
3718
Dave Houlton33c2d252017-06-09 17:08:32 -06003719 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003720 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003721 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003722 LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00247",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003723 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3724 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3725 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003726 }
3727 }
3728
Dave Houlton33c2d252017-06-09 17:08:32 -06003729 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003730 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3731 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003732 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003733 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003734 cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcOffset-00243",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003735 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3736 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003737 }
3738 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3739 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003740 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003741 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003742 cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003743 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003744 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003745 }
3746 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3747 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003748 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003749 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003750 cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcOffset-00246",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003751 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3752 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003753 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003754 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003755 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00215",
3756 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003757 }
Dave Houlton48989f32017-05-26 15:01:46 -06003758
3759 // Validate dest image offsets
3760 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003761 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003762 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003763 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003764 LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-00250",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003765 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3766 "(%1d, %1d). These must be (0, 1).",
3767 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003768 }
3769 }
3770
Dave Houlton33c2d252017-06-09 17:08:32 -06003771 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003772 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003773 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstImage-00252",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003774 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3775 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3776 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003777 }
3778 }
3779
Dave Houlton33c2d252017-06-09 17:08:32 -06003780 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003781 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3782 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003783 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003784 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003785 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstOffset-00248",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003786 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3787 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003788 }
3789 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3790 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003791 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003792 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003793 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003794 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003795 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003796 }
3797 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3798 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003799 oob = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003800 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003801 cb_node->commandBuffer, "VUID-vkCmdBlitImage-dstOffset-00251",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003802 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3803 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003804 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003805 if (oob) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003806 skip |= LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-pRegions-00216",
3807 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003808 }
3809
Dave Houlton33c2d252017-06-09 17:08:32 -06003810 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3811 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3812 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003813 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06003814 LogError(cb_node->commandBuffer, "VUID-vkCmdBlitImage-srcImage-00240",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003815 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3816 "layerCount other than 1.",
3817 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003818 }
3819 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003820 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003821 } else {
3822 assert(0);
3823 }
3824 return skip;
3825}
3826
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003827void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3828 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3829 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003830 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3831 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003832 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003833 auto src_image_state = GetImageState(srcImage);
3834 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003835
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003836 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003837 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003838 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3839 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003840 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003841}
3842
John Zulauf2076e812020-01-08 14:55:54 -07003843GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
3844 assert(map);
3845 // This approach allows for a single hash lookup or/create new
3846 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
3847 if (inserted.second) {
3848 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06003849 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07003850 inserted.first->second.reset(layout_map);
3851 return layout_map;
3852 } else {
3853 assert(nullptr != inserted.first->second.get());
3854 return inserted.first->second.get();
3855 }
3856 return nullptr;
3857}
3858
3859const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
3860 auto it = map.find(image);
3861 if (it != map.end()) {
3862 return it->second.get();
3863 }
3864 return nullptr;
3865}
3866
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003867// 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 -07003868bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
3869 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06003870 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003871 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07003872 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003873 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07003874 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06003875 for (const auto &layout_map_entry : pCB->image_layout_map) {
3876 const auto image = layout_map_entry.first;
3877 const auto *image_state = GetImageState(image);
3878 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003879 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07003880 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06003881 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07003882 if (initial_layout_map.empty()) continue;
3883
3884 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
3885 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
3886 if (global_map == nullptr) {
3887 global_map = &empty_map;
3888 }
3889
3890 // Note: don't know if it would matter
3891 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
3892
3893 auto pos = initial_layout_map.begin();
3894 const auto end = initial_layout_map.end();
3895 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
3896 pos->first.begin);
3897 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07003898 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07003899 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07003900 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 -07003901 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003902 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07003903 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07003904 image_layout = current_layout->pos_B->lower_bound->second;
3905 }
3906 const auto intersected_range = pos->first & current_layout->range;
3907 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3908 // TODO: Set memory invalid which is in mem_tracker currently
3909 } else if (image_layout != initial_layout) {
3910 // Need to look up the inital layout *state* to get a bit more information
3911 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
3912 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3913 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3914 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07003915 // We can report all the errors for the intersected range directly
3916 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06003917 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003918 skip |= LogError(
3919 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003920 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003921 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07003922 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06003923 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06003924 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003925 }
3926 }
John Zulauf2076e812020-01-08 14:55:54 -07003927 if (pos->first.includes(intersected_range.end)) {
3928 current_layout.seek(intersected_range.end);
3929 } else {
3930 ++pos;
3931 if (pos != end) {
3932 current_layout.seek(pos->first.begin);
3933 }
3934 }
John Zulauff660ad62019-03-23 07:16:05 -06003935 }
3936
locke-lunargf155ccf2020-02-18 11:34:15 -07003937 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07003938 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003939 }
John Zulauff660ad62019-03-23 07:16:05 -06003940
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003941 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003942}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003943
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003944void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003945 for (const auto &layout_map_entry : pCB->image_layout_map) {
3946 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07003947 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003948 const auto *image_state = GetImageState(image);
3949 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07003950 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
3951 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07003952 }
3953}
3954
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003955// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003956// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3957// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003958bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3959 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003960 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003961 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003962 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3963
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003964 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07003965 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
3966 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003967 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003968 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3969 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3970 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003971 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003972 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003973 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07003974 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3975 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
3976 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003977 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003978 string_VkImageLayout(first_layout));
3979 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3980 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003981 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003982 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003983 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003984 }
3985 }
sfricke-samsung55f01952020-03-24 08:16:41 -07003986
3987 // Same as above for loadOp, but for stencilLoadOp
3988 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3989 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3990 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3991 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
3992 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003993 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003994 string_VkImageLayout(first_layout));
3995 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
3996 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
3997 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07003998 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07003999 string_VkImageLayout(first_layout));
4000 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4001 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4002 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004003 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004004 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004005 }
4006 }
4007
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004008 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004009}
4010
Mark Lobodzinski96210742017-02-09 10:33:46 -07004011// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4012// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004013template <typename T1>
4014bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4015 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4016 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004017 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004018 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004019 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004020 if (strict) {
4021 correct_usage = ((actual & desired) == desired);
4022 } else {
4023 correct_usage = ((actual & desired) != 0);
4024 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004025
Mark Lobodzinski96210742017-02-09 10:33:46 -07004026 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004027 // All callers should have a valid VUID
4028 assert(msgCode != kVUIDUndefined);
4029 skip =
4030 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4031 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004032 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004033 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004034}
4035
4036// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4037// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004038bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004039 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004040 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004041 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004042}
4043
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004044bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004045 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004046 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004047 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4048 if ((image_format_features & desired) != desired) {
4049 // Same error, but more details if it was an AHB external format
4050 if (image_state->has_ahb_format == true) {
4051 skip |= LogError(image_state->image, vuid,
4052 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4053 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4054 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004055 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004056 } else {
4057 skip |= LogError(image_state->image, vuid,
4058 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4059 "with tiling %s.",
4060 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4061 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4062 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004063 }
4064 }
4065 return skip;
4066}
4067
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004068bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004069 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004070 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004071 // layerCount must not be zero
4072 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004073 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4074 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004075 }
4076 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4077 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004078 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4079 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004080 }
4081 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4082 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4083 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004084 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4085 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4086 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4087 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004088 }
4089 return skip;
4090}
4091
Mark Lobodzinski96210742017-02-09 10:33:46 -07004092// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4093// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004094bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004095 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004096 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004097 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004098}
4099
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004100bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004101 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004102 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004103
4104 const VkDeviceSize &range = pCreateInfo->range;
4105 if (range != VK_WHOLE_SIZE) {
4106 // Range must be greater than 0
4107 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004108 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004109 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004110 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4111 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004112 }
4113 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004114 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4115 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004116 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004117 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004118 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4119 "(%" PRIu32 ").",
4120 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004121 }
4122 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004123 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004124 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004125 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004126 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4127 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4128 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004129 }
4130 // The sum of range and offset must be less than or equal to the size of buffer
4131 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004132 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004133 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004134 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4135 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4136 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004137 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004138 } else {
4139 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4140
4141 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4142 // VkPhysicalDeviceLimits::maxTexelBufferElements
4143 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4144 device_limits->maxTexelBufferElements) {
4145 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4146 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4147 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4148 "), divided by the element size of the format (%" PRIu32
4149 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4150 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4151 device_limits->maxTexelBufferElements);
4152 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004153 }
4154 return skip;
4155}
4156
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004157bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004158 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004159 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004160 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4161 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004162 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004163 "vkCreateBufferView(): If buffer was created with `usage` containing "
4164 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004165 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004166 }
4167 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4168 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004169 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004170 "vkCreateBufferView(): If buffer was created with `usage` containing "
4171 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004172 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004173 }
4174 return skip;
4175}
4176
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004177bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004178 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004179 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004180
Dave Houltond8ed0212018-05-16 17:18:24 -06004181 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004182
Jeff Bolz87697532019-01-11 22:54:00 -06004183 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4184 if (chained_devaddr_struct) {
4185 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4186 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004187 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4188 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4189 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004190 }
4191 }
4192
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004193 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4194 if (chained_opaqueaddr_struct) {
4195 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4196 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004197 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4198 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4199 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004200 }
4201 }
4202
Shannon McPherson4984e642019-12-05 13:04:34 -07004203 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004204 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4205 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004206 skip |= LogError(
4207 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004208 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4209 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4210 }
4211
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004212 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004213 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4214 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4215 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004216 }
4217
sfricke-samsungedce77a2020-07-03 22:35:13 -07004218 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4219 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4220 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4221 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4222 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4223 }
4224 const VkBufferCreateFlags invalid_flags =
4225 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4226 if ((pCreateInfo->flags & invalid_flags) != 0) {
4227 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4228 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4229 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4230 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4231 }
4232 }
4233
Mark Lobodzinski96210742017-02-09 10:33:46 -07004234 return skip;
4235}
4236
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004237bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004238 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004239 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004240 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004241 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4242 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004243 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004244 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4245 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004246 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004247 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4248 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4249 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004250
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004251 // Buffer view offset must be less than the size of buffer
4252 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004253 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004254 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004255 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4256 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004257 }
4258
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004259 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004260 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4261 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4262 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004263 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4264 : "VUID-VkBufferViewCreateInfo-offset-00926";
4265 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004266 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004267 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4268 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004269 }
4270
4271 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4272 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4273 if ((elementSize % 3) == 0) {
4274 elementSize /= 3;
4275 }
4276 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4277 VkDeviceSize alignmentRequirement =
4278 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4279 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4280 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4281 }
4282 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004283 skip |= LogError(
4284 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004285 "vkCreateBufferView(): If buffer was created with usage containing "
4286 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004287 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4288 ") must be a multiple of the lesser of "
4289 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4290 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4291 "(%" PRId32
4292 ") is VK_TRUE, the size of a texel of the requested format. "
4293 "If the size of a texel is a multiple of three bytes, then the size of a "
4294 "single component of format is used instead",
4295 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4296 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4297 }
4298 }
4299 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4300 VkDeviceSize alignmentRequirement =
4301 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4302 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4303 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4304 }
4305 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004306 skip |= LogError(
4307 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004308 "vkCreateBufferView(): If buffer was created with usage containing "
4309 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004310 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4311 ") must be a multiple of the lesser of "
4312 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4313 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4314 "(%" PRId32
4315 ") is VK_TRUE, the size of a texel of the requested format. "
4316 "If the size of a texel is a multiple of three bytes, then the size of a "
4317 "single component of format is used instead",
4318 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4319 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4320 }
4321 }
4322 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004323
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004324 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004325
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004326 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004327 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004328 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004329}
4330
Mark Lobodzinski602de982017-02-09 11:01:33 -07004331// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004332bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004333 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004334 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004335 const IMAGE_STATE *image_state = GetImageState(image);
4336 // checks color format and (single-plane or non-disjoint)
4337 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004338 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004339 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004340 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 -07004341 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004342 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 -07004343 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004344 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004345 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004346 skip |= LogError(image, vuid,
4347 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4348 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4349 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004350 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004351 skip |= LogError(image, vuid,
4352 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4353 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4354 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004355 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004356 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004357 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004358 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 -07004359 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004360 skip |=
4361 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 -07004362 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004363 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004364 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004365 skip |=
4366 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 -07004367 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004368 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4369 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004370 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004371 } else if (FormatIsMultiplane(format)) {
4372 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4373 if (3 == FormatPlaneCount(format)) {
4374 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4375 }
4376 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004377 skip |=
4378 LogError(image, vuid,
4379 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4380 "set, where n = [0, 1, 2].",
4381 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004382 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004383 }
4384 return skip;
4385}
4386
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004387bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4388 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004389 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4390 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004391 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004392
4393 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004394 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004395 skip |= LogError(image, errorCodes.base_mip_err,
4396 "%s: %s.baseMipLevel (= %" PRIu32
4397 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4398 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004399 }
Petr Kraus4d718682017-05-18 03:38:41 +02004400
Petr Krausffa94af2017-08-08 21:46:02 +02004401 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4402 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004403 skip |=
4404 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004405 } else {
4406 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004407
Petr Krausffa94af2017-08-08 21:46:02 +02004408 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004409 skip |= LogError(image, errorCodes.mip_count_err,
4410 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4411 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4412 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4413 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004414 }
Petr Kraus4d718682017-05-18 03:38:41 +02004415 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004416 }
Petr Kraus4d718682017-05-18 03:38:41 +02004417
4418 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004419 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004420 skip |= LogError(image, errorCodes.base_layer_err,
4421 "%s: %s.baseArrayLayer (= %" PRIu32
4422 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4423 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004424 }
Petr Kraus4d718682017-05-18 03:38:41 +02004425
Petr Krausffa94af2017-08-08 21:46:02 +02004426 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4427 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004428 skip |=
4429 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004430 } else {
4431 const uint64_t necessary_layer_count =
4432 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004433
Petr Krausffa94af2017-08-08 21:46:02 +02004434 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004435 skip |= LogError(image, errorCodes.layer_count_err,
4436 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4437 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4438 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4439 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004440 }
Petr Kraus4d718682017-05-18 03:38:41 +02004441 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004442 }
Petr Kraus4d718682017-05-18 03:38:41 +02004443
Mark Lobodzinski602de982017-02-09 11:01:33 -07004444 return skip;
4445}
4446
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004447bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004448 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004449 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004450 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4451 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4452 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4453
4454 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4455 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4456
4457 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004458 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4459 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004460 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004461 : "VUID-VkImageViewCreateInfo-image-01482")
4462 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4463 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004464 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004465 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4466 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004467
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004468 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004469 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004470 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004471}
4472
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004473bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004474 const VkImageSubresourceRange &subresourceRange,
4475 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004476 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004477 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4478 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4479 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4480 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004481
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004482 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004483 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004484 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004485}
4486
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004487bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004488 const VkImageSubresourceRange &subresourceRange,
4489 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004490 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004491 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4492 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4493 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4494 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004495
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004496 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004497 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4498 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004499}
4500
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004501bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004502 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004503 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004504 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004505 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4506 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4507 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4508 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004509
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004510 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004511 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004512}
4513
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004514bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4515 const VkImageUsageFlags image_usage) const {
4516 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4517 bool skip = false;
4518
4519 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4520 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4521
4522 if (image_state->has_ahb_format == true) {
4523 // AHB image view and image share same feature sets
4524 tiling_features = image_state->format_features;
4525 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4526 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4527 assert(device_extensions.vk_ext_image_drm_format_modifier);
4528 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4529 nullptr};
4530 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4531
4532 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4533 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4534 nullptr};
4535 format_properties_2.pNext = (void *)&drm_properties_list;
4536 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4537
4538 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4539 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4540 0) {
4541 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4542 }
4543 }
4544 } else {
4545 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4546 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4547 : format_properties.optimalTilingFeatures;
4548 }
4549
4550 if (tiling_features == 0) {
4551 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4552 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4553 "physical device.",
4554 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4555 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4556 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4557 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4558 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4559 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4560 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4561 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4562 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4563 "VK_IMAGE_USAGE_STORAGE_BIT.",
4564 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4565 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4566 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4567 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4568 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4569 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4570 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4571 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4572 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4573 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4574 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4575 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4576 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4577 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4578 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4579 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4580 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4581 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4582 }
4583
4584 return skip;
4585}
4586
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004587bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004588 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004589 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004590 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004591 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004592 skip |=
4593 ValidateImageUsageFlags(image_state,
4594 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4595 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07004596 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
4597 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4598 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004599 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07004600 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004601 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004602 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004603 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004604 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004605 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004606 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004607
4608 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4609 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004610 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004611 VkFormat view_format = pCreateInfo->format;
4612 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004613 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004614 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004615
Dave Houltonbd2e2622018-04-10 16:41:14 -06004616 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004617 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004618 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004619 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004620 if (!device_extensions.vk_ext_separate_stencil_usage) {
4621 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004622 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4623 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4624 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004625 }
4626 } else {
4627 const auto image_stencil_struct =
4628 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4629 if (image_stencil_struct == nullptr) {
4630 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004631 skip |= LogError(
4632 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004633 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4634 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4635 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4636 }
4637 } else {
4638 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4639 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4640 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004641 skip |= LogError(
4642 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004643 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4644 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4645 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4646 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4647 }
4648 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4649 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004650 skip |= LogError(
4651 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004652 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4653 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4654 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4655 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4656 }
4657 }
4658 }
4659 }
4660
Dave Houltonbd2e2622018-04-10 16:41:14 -06004661 image_usage = chained_ivuci_struct->usage;
4662 }
4663
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004664 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4665 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004666 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004667 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004668 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004669 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004670 std::stringstream ss;
4671 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004672 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004673 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004674 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004675 }
4676 } else {
Nathaniel Cesario0046c312020-10-07 23:28:28 -06004677 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004678 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4679 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004680 const char *error_vuid;
4681 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4682 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4683 } else if ((device_extensions.vk_khr_maintenance2) &&
4684 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4685 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4686 } else if ((!device_extensions.vk_khr_maintenance2) &&
4687 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4688 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4689 } else {
4690 // both enabled
4691 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4692 }
Dave Houltonc7988072018-04-16 11:46:56 -06004693 std::stringstream ss;
4694 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004695 << " is not in the same format compatibility class as "
4696 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004697 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4698 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004699 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004700 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004701 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004702 }
4703 } else {
4704 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004705 // Unless it is a multi-planar color bit aspect
4706 if ((image_format != view_format) &&
4707 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4708 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4709 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004710 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004711 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004712 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004713 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004714 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004715 }
4716 }
4717
4718 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004719 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004720
4721 switch (image_type) {
4722 case VK_IMAGE_TYPE_1D:
4723 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004724 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4725 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4726 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004727 }
4728 break;
4729 case VK_IMAGE_TYPE_2D:
4730 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4731 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4732 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004733 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4734 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4735 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004736 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004737 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4738 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4739 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004740 }
4741 }
4742 break;
4743 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004744 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004745 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4746 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4747 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004748 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004749 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4750 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4751 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004752 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4753 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004754 skip |= LogError(
4755 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4756 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4757 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4758 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4759 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004760 }
4761 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004762 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4763 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4764 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004765 }
4766 }
4767 } else {
4768 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004769 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4770 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4771 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004772 }
4773 }
4774 break;
4775 default:
4776 break;
4777 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004778
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004779 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004780 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004781 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004782 }
4783
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004784 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004785
Jeff Bolz9af91c52018-09-01 21:53:57 -05004786 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4787 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004788 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4789 "vkCreateImageView() If image was created with usage containing "
4790 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4791 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004792 }
4793 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004794 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
4795 "vkCreateImageView() If image was created with usage containing "
4796 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004797 }
4798 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05004799
4800 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
4801 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
4802 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
4803 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
4804 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
4805 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
4806 }
4807 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
4808 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
4809 skip |= LogError(
4810 device, "VUID-VkImageViewCreateInfo-viewType-02963",
4811 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
4812 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
4813 }
4814 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004815
4816 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
4817 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06004818 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004819 "vkCreateImageView(): If image was created with usage containing "
4820 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
4821 pCreateInfo->subresourceRange.levelCount);
4822 }
4823 }
4824 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
4825 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06004826 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004827 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
4828 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
4829 }
4830 } else {
4831 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
4832 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
4833 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06004834 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02004835 "vkCreateImageView(): If image was created with usage containing "
4836 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
4837 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
4838 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
4839 }
4840 }
4841 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07004842
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02004843 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
4844 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
4845 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
4846 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
4847 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
4848 }
4849 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
4850 skip |=
4851 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
4852 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
4853 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
4854 }
4855 }
4856 if (device_extensions.vk_ext_fragment_density_map_2) {
4857 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
4858 (pCreateInfo->subresourceRange.layerCount >
4859 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
4860 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
4861 "vkCreateImageView(): If image was created with flags containing "
4862 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
4863 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
4864 pCreateInfo->subresourceRange.layerCount,
4865 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
4866 }
4867 }
4868
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07004869 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
4870 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
4871 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
4872 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
4873 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
4874 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
4875 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
4876 }
4877 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004878 }
4879 return skip;
4880}
4881
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004882bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
4883 uint32_t regionCount, const VkBufferCopy *pRegions) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004884 bool skip = false;
4885
4886 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4887 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4888 VkDeviceSize src_min = UINT64_MAX;
4889 VkDeviceSize src_max = 0;
4890 VkDeviceSize dst_min = UINT64_MAX;
4891 VkDeviceSize dst_max = 0;
4892
4893 for (uint32_t i = 0; i < regionCount; i++) {
4894 src_min = std::min(src_min, pRegions[i].srcOffset);
4895 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4896 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4897 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4898
4899 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4900 if (pRegions[i].srcOffset >= src_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004901 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-srcOffset-00113",
4902 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4903 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4904 i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004905 }
4906
4907 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4908 if (pRegions[i].dstOffset >= dst_buffer_size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004909 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-dstOffset-00114",
4910 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4911 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4912 i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004913 }
4914
4915 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4916 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004917 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00115",
4918 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4919 ") is greater than the source buffer size (%" PRIuLEAST64
4920 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4921 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004922 }
4923
4924 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4925 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004926 skip |= LogError(dst_buffer_state->buffer, "VUID-vkCmdCopyBuffer-size-00116",
4927 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4928 ") is greater than the destination buffer size (%" PRIuLEAST64
4929 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4930 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004931 }
4932 }
4933
4934 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4935 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4936 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004937 skip |= LogError(src_buffer_state->buffer, "VUID-vkCmdCopyBuffer-pRegions-00117",
4938 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004939 }
4940 }
4941
4942 return skip;
4943}
4944
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004945bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004946 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004947 const auto cb_node = GetCBState(commandBuffer);
4948 const auto src_buffer_state = GetBufferState(srcBuffer);
4949 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004950
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004951 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004952 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4953 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004954 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004955 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004956 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4957 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004958 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004959 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4960 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004961 skip |=
4962 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4963 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004964 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4965 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004966 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions);
sfricke-samsung022fa252020-07-24 03:26:16 -07004967 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
4968 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
4969 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004970 return skip;
4971}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004972
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004973bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004974 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004975 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07004976 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004977 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004978 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
4979 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004980 }
4981 }
4982 return skip;
4983}
4984
Jeff Bolz5c801d12019-10-09 10:38:45 -05004985bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4986 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004987 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004988 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004989
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004990 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004991 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004992 skip |=
4993 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004994 }
4995 return skip;
4996}
4997
Jeff Bolz5c801d12019-10-09 10:38:45 -05004998bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004999 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005000
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005001 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005002 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005003 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005004 }
5005 return skip;
5006}
5007
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005008bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005009 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005010 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005011 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005012 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005013 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005014 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005015 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005016 }
5017 return skip;
5018}
5019
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005020bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005021 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005022 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005023 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005024 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005025 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005026 skip |=
5027 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5028 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005029 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005030 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005031 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5032 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005033 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005034
sfricke-samsung022fa252020-07-24 03:26:16 -07005035 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5036 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5037
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005038 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005039 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5040 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5041 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5042 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005043 }
5044
5045 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005046 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5047 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5048 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5049 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005050 }
5051
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005052 return skip;
5053}
5054
sfricke-samsungd0659242020-08-18 22:38:43 -07005055bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
5056 const VkBufferImageCopy *pRegions, const IMAGE_STATE *image_state,
5057 const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005058 bool skip = false;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005059 assert(image_state != nullptr);
5060 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005061
5062 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005063 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005064 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5065 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005066 skip |=
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005067 LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-srcImage-00199",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005068 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5069 "and 1, respectively.",
5070 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005071 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005072 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005073
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005074 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5075 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005076 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-srcImage-00201",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005077 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
5078 "must be 0 and 1, respectively.",
5079 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005080 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005081 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005082
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005083 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5084 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005085 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005086 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5087 "For 3D images these must be 0 and 1, respectively.",
5088 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005089 }
5090 }
5091
5092 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005093 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005094 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005095
sfricke-samsung125d2b42020-05-28 06:32:43 -07005096 // If not depth/stencil and not multi-plane
5097 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5098 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005099 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5100 ? "VUID-vkCmdCopyBufferToImage-bufferOffset-01558"
5101 : "VUID-vkCmdCopyBufferToImage-bufferOffset-00193";
sfricke-samsung125d2b42020-05-28 06:32:43 -07005102 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005103 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
5104 " must be a multiple of this format's texel size (%" PRIu32 ").",
5105 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005106 }
5107
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005108 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5109 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005110 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005111 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
5112 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5113 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005114 }
5115
5116 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5117 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005118 skip |= LogError(
5119 image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005120 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5121 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005122 }
5123
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005124 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005125 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005126 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005127 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 -06005128 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5129 static_cast<int32_t>(adjusted_image_extent.width))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005130 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00197",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005131 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5132 "zero or <= image subresource width (%d).",
5133 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005134 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005135 }
5136
5137 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005138 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 -06005139 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5140 static_cast<int32_t>(adjusted_image_extent.height))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005141 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00198",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005142 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5143 "zero or <= image subresource height (%d).",
5144 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005145 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005146 }
5147
5148 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005149 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 -06005150 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5151 static_cast<int32_t>(adjusted_image_extent.depth))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005152 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005153 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5154 "zero or <= image subresource depth (%d).",
5155 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005156 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005157 }
5158
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005159 // subresource aspectMask must have exactly 1 bit set
5160 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005161 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005162 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005163 skip |= LogError(image_state->image, "VUID-VkBufferImageCopy-aspectMask-00212",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07005164 "%s(): aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005165 }
5166
5167 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005168 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005169 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005170 image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005171 "%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 -07005172 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005173 }
5174
5175 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005176 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5177 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005178
5179 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005180 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005181 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005182 ? "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203"
5183 : "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005184 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005185 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005186 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5187 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005188 }
5189
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005190 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005191 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005192 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005193 ? "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204"
5194 : "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005195 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005196 image_state->image, vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005197 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5198 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005199 }
5200
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005201 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005202 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5203 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5204 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005205 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5206 ? "VUID-vkCmdCopyBufferToImage-imageOffset-00205"
5207 : "VUID-vkCmdCopyBufferToImage-imageOffset-00205";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005208 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005209 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5210 "width & height (%d, %d)..",
5211 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5212 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005213 }
5214
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005215 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005216 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005217 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung3a10b922020-05-13 23:23:16 -07005218 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005219 ? "VUID-vkCmdCopyBufferToImage-bufferOffset-00206"
5220 : "VUID-vkCmdCopyBufferToImage-bufferOffset-00206";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005221 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005222 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
5223 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5224 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005225 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005226
5227 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005228 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005229 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005230 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005231 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5232 ? "VUID-vkCmdCopyBufferToImage-imageExtent-00207"
5233 : "VUID-vkCmdCopyBufferToImage-imageExtent-00207";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005234 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005235 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
5236 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5237 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5238 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005239 }
5240
5241 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005242 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005243 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005244 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5245 ? "VUID-vkCmdCopyBufferToImage-imageExtent-00208"
5246 : "VUID-vkCmdCopyBufferToImage-imageExtent-00208";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005247 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005248 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
5249 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5250 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5251 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005252 }
5253
5254 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005255 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005256 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005257 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5258 ? "VUID-vkCmdCopyBufferToImage-imageExtent-00209"
5259 : "VUID-vkCmdCopyBufferToImage-imageExtent-00209";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005260 skip |= LogError(image_state->image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005261 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
5262 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5263 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5264 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005265 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005266 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005267
5268 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005269 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005270 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005271 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005272 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005273 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5274 "format has three planes.",
5275 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005276 }
5277
5278 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005279 if (0 ==
5280 (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 -06005281 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005282 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5283 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5284 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005285 } else {
5286 // Know aspect mask is valid
5287 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5288 const uint32_t compatible_size = FormatElementSize(compatible_format);
5289 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5290 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005291 image_state->image, "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
sfricke-samsung125d2b42020-05-28 06:32:43 -07005292 "%s(): pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
5293 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5294 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5295 string_VkFormat(compatible_format));
5296 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005297 }
5298 }
sfricke-samsungd0659242020-08-18 22:38:43 -07005299
5300 // Checks depth or stencil aspect are used in graphics queue
5301 if ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0) {
5302 assert(cb_node != nullptr);
5303 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
5304 if (command_pool != nullptr) {
5305 const uint32_t queueFamilyIndex = command_pool->queueFamilyIndex;
5306 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queueFamilyIndex].queueFlags;
5307
5308 if ((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) {
5309 LogObjectList objlist(cb_node->commandBuffer);
5310 objlist.add(command_pool->commandPool);
5311 // TODO - Label when future headers get merged in from internral MR 4077 fix
5312 skip |=
5313 LogError(image_state->image, "UNASSIGNED-VkBufferImageCopy-aspectMask",
5314 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
5315 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
5316 "which was create with queueFamilyIndex %u which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
5317 function, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
5318 report_data->FormatHandle(command_pool->commandPool).c_str(), queueFamilyIndex);
5319 }
5320 }
5321 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005322 }
5323
5324 return skip;
5325}
5326
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005327bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount, const VkBufferImageCopy *pRegions,
5328 const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005329 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005330 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005331
5332 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005333 VkExtent3D extent = pRegions[i].imageExtent;
5334 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005335
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005336 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5337 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005338 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5339 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5340 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005341 }
5342
5343 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5344
5345 // 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 -06005346 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005347 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005348 if (image_extent.width % block_extent.width) {
5349 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5350 }
5351 if (image_extent.height % block_extent.height) {
5352 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5353 }
5354 if (image_extent.depth % block_extent.depth) {
5355 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5356 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005357 }
5358
Dave Houltonfc1a4052017-04-27 14:32:45 -06005359 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005360 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005361 }
5362 }
5363
5364 return skip;
5365}
5366
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005367bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
5368 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005369 bool skip = false;
5370
5371 VkDeviceSize buffer_size = buff_state->createInfo.size;
5372
5373 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005374 VkDeviceSize max_buffer_offset =
5375 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5376 if (buffer_size < max_buffer_offset) {
5377 skip |=
5378 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 -07005379 }
5380 }
5381
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005382 return skip;
5383}
5384
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005385bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005386 VkBuffer dstBuffer, uint32_t regionCount,
5387 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005388 const auto cb_node = GetCBState(commandBuffer);
5389 const auto src_image_state = GetImageState(srcImage);
5390 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005391
sfricke-samsungd0659242020-08-18 22:38:43 -07005392 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005393
5394 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005395 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005396
5397 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005398 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005399
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005400 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005401
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005402 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005403 skip |=
5404 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
5405 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
5406 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005407 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005408 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005409 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005410 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005411 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005412
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005413 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005414 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005415 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5416 skip |=
5417 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005418
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005419 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005420 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005421 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5422 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005423 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005424 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5425 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
sfricke-samsung022fa252020-07-24 03:26:16 -07005426 skip |= ValidateProtectedImage(cb_node, src_image_state, "vkCmdCopyImageToBuffer()",
5427 "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831");
5428 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyImageToBuffer()",
5429 "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832");
5430 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyImageToBuffer()",
5431 "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005432
5433 // Validation for VK_EXT_fragment_density_map
5434 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5435 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyImageToBuffer-srcImage-02544",
5436 "vkCmdCopyBufferToImage(): srcImage must not have been created with flags containing "
5437 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5438 }
5439
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005440 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005441 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005442 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005443 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005444 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005445 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005446 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5447 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5448 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005449 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005450 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005451 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005452 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005453 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5454 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005455 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5456 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5457 skip |=
5458 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5459 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5460 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005461 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5462 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005463 }
5464 return skip;
5465}
5466
John Zulauf1686f232019-07-09 16:27:11 -06005467void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5468 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5469 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5470
5471 auto cb_node = GetCBState(commandBuffer);
5472 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005473 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005474 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005475 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005476 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005477}
5478
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005479bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5480 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005481 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005482 const auto cb_node = GetCBState(commandBuffer);
5483 const auto src_buffer_state = GetBufferState(srcBuffer);
5484 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005485
sfricke-samsungd0659242020-08-18 22:38:43 -07005486 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005487
5488 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005489 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005490
5491 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005492 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005493 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005494 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005495 skip |=
5496 LogError(cb_node->createInfo.commandPool, "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
5497 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
5498 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005499 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005500 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005501 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005502 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005503 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005504 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005505 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005506 skip |=
5507 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5508 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005509 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005510 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5511 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005512 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005513 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5514 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
sfricke-samsung022fa252020-07-24 03:26:16 -07005515 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBufferToImage()",
5516 "VUID-vkCmdCopyBufferToImage-commandBuffer-01828");
5517 skip |= ValidateProtectedImage(cb_node, dst_image_state, "vkCmdCopyBufferToImage()",
5518 "VUID-vkCmdCopyBufferToImage-commandBuffer-01829");
5519 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, "vkCmdCopyBufferToImage()",
5520 "VUID-vkCmdCopyBufferToImage-commandBuffer-01830");
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005521
5522 // Validation for VK_EXT_fragment_density_map
5523 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
5524 skip |= LogError(cb_node->commandBuffer, "vkCmdCopyBufferToImage-dstImage-02543",
5525 "vkCmdCopyBufferToImage(): dstImage must not have been created with flags containing "
5526 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT");
5527 }
5528
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005529 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005530 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005531 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005532 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005533 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005534 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005535 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5536 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5537 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005538 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005539 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005540 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005541 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005542 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5543 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005544 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5545 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5546 skip |=
5547 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5548 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5549 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005550 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5551 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005552 }
5553 return skip;
5554}
5555
John Zulauf1686f232019-07-09 16:27:11 -06005556void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5557 VkImageLayout dstImageLayout, uint32_t regionCount,
5558 const VkBufferImageCopy *pRegions) {
5559 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5560
5561 auto cb_node = GetCBState(commandBuffer);
5562 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005563 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005564 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005565 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005566 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005567}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005568
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005569bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005570 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005571 bool skip = false;
5572 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5573
Dave Houlton1d960ff2018-01-19 12:17:05 -07005574 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005575 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5576 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5577 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005578 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5579 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005580 }
5581
John Zulaufa26d3c82019-08-14 16:09:08 -06005582 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005583 if (!image_entry) {
5584 return skip;
5585 }
5586
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005587 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5588 if (device_extensions.vk_ext_image_drm_format_modifier) {
5589 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5590 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005591 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5592 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5593 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005594 }
5595 } else {
5596 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005597 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5598 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005599 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005600 }
5601
Dave Houlton1d960ff2018-01-19 12:17:05 -07005602 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005603 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005604 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5605 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5606 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005607 }
5608
Dave Houlton1d960ff2018-01-19 12:17:05 -07005609 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005610 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005611 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5612 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5613 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005614 }
5615
Dave Houlton1d960ff2018-01-19 12:17:05 -07005616 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005617 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005618 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5619 if (FormatIsMultiplane(img_format)) {
5620 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5621 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5622 if (FormatPlaneCount(img_format) > 2u) {
5623 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5624 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5625 }
5626 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005627 skip |= LogError(image, vuid,
5628 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5629 ") must be a single-plane specifier flag.",
5630 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005631 }
5632 } else if (FormatIsColor(img_format)) {
5633 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005634 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5635 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5636 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005637 }
5638 } else if (FormatIsDepthOrStencil(img_format)) {
5639 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5640 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005641 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005642 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5643 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5644 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5645 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005646 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5647 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5648 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005649 }
5650 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005651
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005652 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005653 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005654 }
5655
Mike Weiblen672b58b2017-02-21 14:32:53 -07005656 return skip;
5657}
sfricke-samsung022fa252020-07-24 03:26:16 -07005658
5659// Validates the image is allowed to be protected
5660bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
5661 const char *vuid) const {
5662 bool skip = false;
5663 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
5664 LogObjectList objlist(cb_state->commandBuffer);
5665 objlist.add(image_state->image);
5666 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while image %s is a protected image", cmd_name,
5667 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
5668 report_data->FormatHandle(image_state->image).c_str());
5669 }
5670 return skip;
5671}
5672
5673// Validates the image is allowed to be unprotected
5674bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
5675 const char *vuid) const {
5676 bool skip = false;
5677 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
5678 LogObjectList objlist(cb_state->commandBuffer);
5679 objlist.add(image_state->image);
5680 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while image %s is an unprotected image", cmd_name,
5681 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
5682 report_data->FormatHandle(image_state->image).c_str());
5683 }
5684 return skip;
5685}
5686
5687// Validates the buffer is allowed to be protected
5688bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
5689 const char *vuid) const {
5690 bool skip = false;
5691 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
5692 LogObjectList objlist(cb_state->commandBuffer);
5693 objlist.add(buffer_state->buffer);
5694 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while buffer %s is a protected buffer", cmd_name,
5695 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
5696 report_data->FormatHandle(buffer_state->buffer).c_str());
5697 }
5698 return skip;
5699}
5700
5701// Validates the buffer is allowed to be unprotected
5702bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
5703 const char *vuid) const {
5704 bool skip = false;
5705 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
5706 LogObjectList objlist(cb_state->commandBuffer);
5707 objlist.add(buffer_state->buffer);
5708 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while buffer %s is an unprotected buffer", cmd_name,
5709 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
5710 report_data->FormatHandle(buffer_state->buffer).c_str());
5711 }
5712 return skip;
5713}