blob: 5739ad4e6fad6b9fdde7530cabbc2840b655e047 [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-lunarg654a9052020-10-13 16:28:42 -0600279const cvdescriptorset::DescriptorSet *CMD_BUFFER_STATE::GetDescriptorSet(VkPipelineBindPoint bind_point, uint32_t set) const {
280 const auto last_bound_it = lastBound.find(bind_point);
281 if (last_bound_it == lastBound.cend()) {
282 return nullptr;
283 }
284 if (set >= last_bound_it->second.per_set.size()) {
285 return nullptr;
286 }
287 return last_bound_it->second.per_set[set].bound_descriptor_set;
288}
289
locke-lunarg36045992020-08-20 16:54:37 -0600290const cvdescriptorset::Descriptor *CMD_BUFFER_STATE::GetDescriptor(VkShaderStageFlagBits shader_stage, uint32_t set,
291 uint32_t binding, uint32_t index) const {
292 VkPipelineBindPoint bind_point;
293
294 if (shader_stage & VK_SHADER_STAGE_ALL_GRAPHICS) {
295 bind_point = VK_PIPELINE_BIND_POINT_GRAPHICS;
296 } else if (shader_stage & VK_SHADER_STAGE_COMPUTE_BIT) {
297 bind_point = VK_PIPELINE_BIND_POINT_COMPUTE;
298 } else {
299 bind_point = VK_PIPELINE_BIND_POINT_RAY_TRACING_KHR;
300 }
301
302 return GetDescriptor(bind_point, set, binding, index);
303}
304
305const cvdescriptorset::Descriptor *CMD_BUFFER_STATE::GetDescriptor(VkPipelineBindPoint bind_point, uint32_t set, uint32_t binding,
306 uint32_t index) const {
307 const auto last_bound_it = lastBound.find(bind_point);
308 if (last_bound_it == lastBound.cend()) {
309 return nullptr;
310 }
311 if (set >= last_bound_it->second.per_set.size()) {
312 return nullptr;
313 }
314 return last_bound_it->second.per_set[set].bound_descriptor_set->GetDescriptorFromBinding(binding, index);
315}
316
Dave Houltond9611312018-11-19 17:03:36 -0700317uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
318 // uint cast applies floor()
319 return 1u + (uint32_t)log2(std::max({height, width, depth}));
320}
321
322uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
323
324uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
325
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500326bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700327 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700328 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700329
John Zulauf2076e812020-01-08 14:55:54 -0700330 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
331 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700332 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
333 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
334
John Zulauf2076e812020-01-08 14:55:54 -0700335 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
336
337 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
338 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700339 return false;
340 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700341
John Zulauf2076e812020-01-08 14:55:54 -0700342 for (auto entry : *layout_range_map) {
343 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700344 }
345 return true;
346}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700347
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600348// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600349void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600350 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
351 VkImageLayout expected_layout) {
352 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
353 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600354 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600355 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700356 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700357 for (const auto &image : image_state.aliasing_images) {
358 auto alias_state = GetImageState(image);
359 // The map state of the aliases should all be in sync, so no need to check the return value
360 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
361 assert(subresource_map);
362 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
363 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700364}
John Zulauff660ad62019-03-23 07:16:05 -0600365
366// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600367void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600368 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500369 return;
370 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500371 IMAGE_STATE *image_state = view_state.image_state.get();
372 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700373 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700374 for (const auto &image : image_state->aliasing_images) {
375 image_state = GetImageState(image);
376 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
377 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
378 }
John Zulauff660ad62019-03-23 07:16:05 -0600379}
380
381// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600382void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600383 const VkImageSubresourceRange &range, VkImageLayout layout) {
384 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
385 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600386 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700387 for (const auto &image : image_state.aliasing_images) {
388 auto alias_state = GetImageState(image);
389 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
390 assert(subresource_map);
391 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
392 }
John Zulauff660ad62019-03-23 07:16:05 -0600393}
394
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600395void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600396 VkImageLayout layout) {
397 const IMAGE_STATE *image_state = GetImageState(image);
398 if (!image_state) return;
399 SetImageInitialLayout(cb_node, *image_state, range, layout);
400};
401
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600402void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600403 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
404 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600405}
Dave Houltonddd65c52018-05-08 14:58:01 -0600406
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600407// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700408void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
409 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500410 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600411
John Zulauff660ad62019-03-23 07:16:05 -0600412 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600413 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
414 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600415 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 -0600416 sub_range.baseArrayLayer = 0;
417 sub_range.layerCount = image_state->createInfo.extent.depth;
418 }
419
Piers Daniell4fde9b72019-11-27 16:19:46 -0700420 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
421 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
422 SetImageLayout(cb_node, *image_state, sub_range, layout);
423 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
424 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
425 } else {
426 SetImageLayout(cb_node, *image_state, sub_range, layout);
427 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600428}
429
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700430bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
431 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700432 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600433 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100434 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700435 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100436 const char *vuid;
437 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700438 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100439
440 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600441 LogObjectList objlist(image);
442 objlist.add(renderpass);
443 objlist.add(framebuffer);
444 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700445 skip |=
446 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
447 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
448 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
449 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100450 return skip;
451 }
452
453 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200454 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
455 if (stencil_usage_info) {
456 image_usage |= stencil_usage_info->stencilUsage;
457 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100458
459 // Check for layouts that mismatch image usages in the framebuffer
460 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800461 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600462 LogObjectList objlist(image);
463 objlist.add(renderpass);
464 objlist.add(framebuffer);
465 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700466 skip |= LogError(objlist, vuid,
467 "%s: Layout/usage mismatch for attachment %u in %s"
468 " - the %s is %s but the image attached to %s via %s"
469 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
470 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
471 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
472 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100473 }
474
475 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
476 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800477 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600478 LogObjectList objlist(image);
479 objlist.add(renderpass);
480 objlist.add(framebuffer);
481 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700482 skip |= LogError(objlist, vuid,
483 "%s: Layout/usage mismatch for attachment %u in %s"
484 " - the %s is %s but the image attached to %s via %s"
485 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
486 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
487 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
488 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100489 }
490
491 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800492 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600493 LogObjectList objlist(image);
494 objlist.add(renderpass);
495 objlist.add(framebuffer);
496 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700497 skip |= LogError(objlist, vuid,
498 "%s: Layout/usage mismatch for attachment %u in %s"
499 " - the %s is %s but the image attached to %s via %s"
500 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
501 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
502 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
503 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100504 }
505
506 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800507 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600508 LogObjectList objlist(image);
509 objlist.add(renderpass);
510 objlist.add(framebuffer);
511 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700512 skip |= LogError(objlist, vuid,
513 "%s: Layout/usage mismatch for attachment %u in %s"
514 " - the %s is %s but the image attached to %s via %s"
515 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
516 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
517 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
518 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100519 }
520
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600521 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100522 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
523 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
524 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
525 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
526 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800527 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600528 LogObjectList objlist(image);
529 objlist.add(renderpass);
530 objlist.add(framebuffer);
531 objlist.add(image_view);
532 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700533 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700534 " - the %s is %s but the image attached to %s via %s"
535 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700536 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700537 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
538 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100539 }
540 } else {
541 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
542 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
543 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
544 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600545 LogObjectList objlist(image);
546 objlist.add(renderpass);
547 objlist.add(framebuffer);
548 objlist.add(image_view);
549 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700550 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700551 " - the %s is %s but the image attached to %s via %s"
552 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700553 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700554 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
555 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100556 }
557 }
558 return skip;
559}
560
John Zulauf17a01bb2019-08-09 16:41:19 -0600561bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700562 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600563 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600564 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700565 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700566 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100567 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100568
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700569 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100570 auto framebuffer = framebuffer_state->framebuffer;
571
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700572 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700573 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
574 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700575 }
John Zulauf8e308292018-09-21 11:34:37 -0600576
Tobias Hectorc9057422019-07-23 12:15:52 +0100577 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
578 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
579 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100580 }
581
Tobias Hectorc9057422019-07-23 12:15:52 +0100582 if (attachments != nullptr) {
583 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
584 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
585 auto image_view = attachments[i];
586 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100587
Tobias Hectorc9057422019-07-23 12:15:52 +0100588 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600589 LogObjectList objlist(pRenderPassBegin->renderPass);
590 objlist.add(framebuffer_state->framebuffer);
591 objlist.add(image_view);
592 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700593 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
594 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
595 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100596 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100597 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100598
599 const VkImage image = view_state->create_info.image;
600 const IMAGE_STATE *image_state = GetImageState(image);
601
602 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600603 LogObjectList objlist(pRenderPassBegin->renderPass);
604 objlist.add(framebuffer_state->framebuffer);
605 objlist.add(image_view);
606 objlist.add(image);
607 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700608 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
609 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
610 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100611 continue;
612 }
613 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
614 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
615
Piers Daniell7f894f62020-01-09 16:33:48 -0700616 // Default to expecting stencil in the same layout.
617 auto attachment_stencil_initial_layout = attachment_initial_layout;
618
619 // If a separate layout is specified, look for that.
620 const auto *attachment_description_stencil_layout =
621 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
622 if (attachment_description_stencil_layout) {
623 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
624 }
625
Tobias Hectorc9057422019-07-23 12:15:52 +0100626 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
627 // in common with the non-const version.)
628 const ImageSubresourceLayoutMap *subresource_map =
629 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
630
631 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
632 LayoutUseCheckAndMessage layout_check(subresource_map);
633 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700634 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
635 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
636 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700637
John Zulauf5e617452019-11-19 14:44:16 -0700638 // Allow for differing depth and stencil layouts
639 VkImageLayout check_layout = attachment_initial_layout;
640 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
641
642 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700643 subres_skip |= LogError(
644 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700645 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
646 "and the %s layout of the attachment is %s. The layouts must match, or the render "
647 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700648 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100649 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700650 }
John Zulauf5e617452019-11-19 14:44:16 -0700651
Tobias Hectorc9057422019-07-23 12:15:52 +0100652 skip |= subres_skip;
653 }
654
655 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
656 framebuffer, render_pass, i, "initial layout");
657
658 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
659 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100660 }
661
Tobias Hectorc9057422019-07-23 12:15:52 +0100662 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
663 auto &subpass = pRenderPassInfo->pSubpasses[j];
664 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
665 auto &attachment_ref = subpass.pInputAttachments[k];
666 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
667 auto image_view = attachments[attachment_ref.attachment];
668 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100669
Tobias Hectorc9057422019-07-23 12:15:52 +0100670 if (view_state) {
671 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700672 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
673 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100674 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100675 }
676 }
677 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100678
Tobias Hectorc9057422019-07-23 12:15:52 +0100679 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
680 auto &attachment_ref = subpass.pColorAttachments[k];
681 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
682 auto image_view = attachments[attachment_ref.attachment];
683 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100684
Tobias Hectorc9057422019-07-23 12:15:52 +0100685 if (view_state) {
686 auto image = view_state->create_info.image;
687 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
688 framebuffer, render_pass, attachment_ref.attachment,
689 "color attachment layout");
690 if (subpass.pResolveAttachments) {
691 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
692 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
693 attachment_ref.attachment, "resolve attachment layout");
694 }
695 }
696 }
697 }
698
699 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
700 auto &attachment_ref = *subpass.pDepthStencilAttachment;
701 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
702 auto image_view = attachments[attachment_ref.attachment];
703 auto view_state = GetImageViewState(image_view);
704
705 if (view_state) {
706 auto image = view_state->create_info.image;
707 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
708 framebuffer, render_pass, attachment_ref.attachment,
709 "input attachment layout");
710 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100711 }
712 }
713 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700714 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600715 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700716}
717
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600718void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700719 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700720 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700721 IMAGE_VIEW_STATE *image_view = nullptr;
722 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
723 const auto attachment_info =
724 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
725 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
726 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300727 image_view = GetAttachmentImageViewState(pCB, pFramebuffer, ref.attachment);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700728 }
John Zulauf8e308292018-09-21 11:34:37 -0600729 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700730 VkImageLayout stencil_layout = kInvalidLayout;
731 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
732 if (attachment_reference_stencil_layout) {
733 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
734 }
735
736 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600737 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700738 }
739}
740
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600741void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
742 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700743 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700744
745 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700746 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700747 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700748 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700749 }
750 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700751 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700752 }
753 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700754 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700755 }
756 }
757}
758
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700759// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
760// 1. Transition into initialLayout state
761// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600762void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700763 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700764 // First transition into initialLayout
765 auto const rpci = render_pass_state->createInfo.ptr();
766 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700767 IMAGE_VIEW_STATE *view_state = nullptr;
768 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
769 const auto attachment_info =
770 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
771 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
772 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300773 view_state = GetAttachmentImageViewState(cb_state, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700774 }
John Zulauf8e308292018-09-21 11:34:37 -0600775 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700776 VkImageLayout stencil_layout = kInvalidLayout;
777 const auto *attachment_description_stencil_layout =
778 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
779 if (attachment_description_stencil_layout) {
780 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
781 }
782
783 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600784 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700785 }
786 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700787 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700788}
789
Dave Houlton10b39482017-03-16 13:18:15 -0600790bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600791 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600792 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600793 }
794 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600795 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600796 }
797 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600798 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600799 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700800 if (0 !=
801 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
802 if (FormatPlaneCount(format) == 1) return false;
803 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600804 return true;
805}
806
Mike Weiblen62d08a32017-03-07 22:18:27 -0700807// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200808bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
809 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600810 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700811 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200812 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600813 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700814
815 switch (layout) {
816 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
817 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600818 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700819 }
820 break;
821 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
822 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600823 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700824 }
825 break;
826 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
827 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600828 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700829 }
830 break;
831 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
832 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600833 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700834 }
835 break;
836 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
837 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600838 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700839 }
840 break;
841 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
842 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600843 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700844 }
845 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600846 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500847 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
848 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
849 }
850 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700851 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
852 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
853 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
854 }
855 break;
856 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
857 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
858 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
859 }
860 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700861 default:
862 // Other VkImageLayout values do not have VUs defined in this context.
863 break;
864 }
865
Dave Houlton8e9f6542018-05-18 12:18:22 -0600866 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700867 skip |= LogError(img_barrier.image, msg_code,
868 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
869 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
870 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700871 }
872 return skip;
873}
874
875// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600876bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
877 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700878 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700879
Petr Krausad0096a2019-08-09 18:35:04 +0200880 // Scoreboard for checking for duplicate and inconsistent barriers to images
881 struct ImageBarrierScoreboardEntry {
882 uint32_t index;
883 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
884 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
885 const VkImageMemoryBarrier *barrier;
886 };
887 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
888 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
889
John Zulauf463c51e2018-05-31 13:29:20 -0600890 // Scoreboard for duplicate layout transition barriers within the list
891 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
892 ImageBarrierScoreboardImageMap layout_transitions;
893
Mike Weiblen62d08a32017-03-07 22:18:27 -0700894 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200895 const auto &img_barrier = pImageMemoryBarriers[i];
896 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700897
John Zulauf463c51e2018-05-31 13:29:20 -0600898 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
899 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
900 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200901 if (img_barrier.oldLayout != img_barrier.newLayout) {
902 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
903 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600904 if (image_it != layout_transitions.end()) {
905 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200906 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600907 if (subres_it != subres_map.end()) {
908 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200909 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
910 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
911 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700912 skip = LogError(
913 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200914 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600915 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
916 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200917 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
918 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
919 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600920 }
921 entry = new_entry;
922 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200923 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600924 }
925 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200926 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600927 }
928 }
929
Petr Krausad0096a2019-08-09 18:35:04 +0200930 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600931 if (image_state) {
932 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200933 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
934 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600935
936 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
937 if (image_state->layout_locked) {
938 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700939 skip |= LogError(
940 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700941 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600942 " 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 -0700943 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200944 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600945 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600946
John Zulaufa4472282019-08-22 14:44:34 -0600947 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700948 const VkFormat image_format = image_create_info.format;
949 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600950 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700951 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700952 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600953 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
954 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700955 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
956 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
957 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
958 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700959 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600960 }
961 } else {
962 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
963 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -0700964 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
965 ? "VUID-VkImageMemoryBarrier-image-03320"
966 : "VUID-VkImageMemoryBarrier-image-01207";
967 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700968 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
969 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
970 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700971 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600972 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700973 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700974 }
John Zulauff660ad62019-03-23 07:16:05 -0600975
Petr Krausad0096a2019-08-09 18:35:04 +0200976 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
977 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600978 // TODO: Set memory invalid which is in mem_tracker currently
979 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
980 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600981 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600982 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600983 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200984 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700985 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
986 const auto &value = *pos;
987 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700988 subres_skip = LogError(
989 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700990 "%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 -0700991 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700992 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -0700993 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
994 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600995 }
John Zulauf5e617452019-11-19 14:44:16 -0700996 }
John Zulauff660ad62019-03-23 07:16:05 -0600997 skip |= subres_skip;
998 }
sfricke-samsung79b00482020-04-01 21:15:50 -0700999
1000 // checks color format and (single-plane or non-disjoint)
1001 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1002 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001003 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001004 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
1005 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
1006 ? "VUID-VkImageMemoryBarrier-image-01671"
1007 : "VUID-VkImageMemoryBarrier-image-02902";
1008 skip |= LogError(img_barrier.image, vuid,
1009 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
1010 "but its aspectMask is 0x%" PRIx32 ".",
1011 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1012 string_VkFormat(image_format), aspect_mask);
1013 }
1014 }
1015
1016 VkImageAspectFlags valid_disjoint_mask =
1017 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 -07001018 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001019 ((aspect_mask & valid_disjoint_mask) == 0)) {
1020 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
1021 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
1022 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
1023 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1024 string_VkFormat(image_format), aspect_mask);
1025 }
1026
1027 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
1028 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
1029 "%s: Image barrier %s references %s of format %s has only two planes but included "
1030 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
1031 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1032 string_VkFormat(image_format), aspect_mask);
1033 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001034 }
1035 }
1036 return skip;
1037}
1038
John Zulaufe3d1c8a2019-08-12 14:34:58 -06001039bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +02001040 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -07001041
Jeff Bolz6835fda2019-10-06 00:15:34 -05001042 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +02001043 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001044}
1045
John Zulauf6b4aae82018-05-09 13:03:36 -06001046template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001047bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
1048 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001049 using BarrierRecord = QFOTransferBarrier<Barrier>;
1050 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001051 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001052 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
1053 const char *barrier_name = BarrierRecord::BarrierName();
1054 const char *handle_name = BarrierRecord::HandleName();
1055 const char *transfer_type = nullptr;
1056 for (uint32_t b = 0; b < barrier_count; b++) {
1057 if (!IsTransferOp(&barriers[b])) continue;
1058 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001059 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001060 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001061 const auto found = barrier_sets.release.find(barriers[b]);
1062 if (found != barrier_sets.release.cend()) {
1063 barrier_record = &(*found);
1064 transfer_type = "releasing";
1065 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -06001066 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001067 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001068 const auto found = barrier_sets.acquire.find(barriers[b]);
1069 if (found != barrier_sets.acquire.cend()) {
1070 barrier_record = &(*found);
1071 transfer_type = "acquiring";
1072 }
1073 }
1074 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001075 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
1076 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1077 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
1078 func_name, barrier_name, b, transfer_type, handle_name,
1079 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
1080 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001081 }
1082 }
1083 return skip;
1084}
1085
John Zulaufa4472282019-08-22 14:44:34 -06001086VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1087 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1088}
1089
1090const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1091 return device_state.GetImageState(barrier.image);
1092}
1093
1094VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1095 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1096}
1097
1098const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1099 return device_state.GetBufferState(barrier.buffer);
1100}
1101
1102VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1103
John Zulauf6b4aae82018-05-09 13:03:36 -06001104template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001105void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1106 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001107 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001108 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1109 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001110 auto &barrier = barriers[b];
1111 if (IsTransferOp(&barrier)) {
1112 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001113 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001114 barrier_sets.release.emplace(barrier);
1115 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001116 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001117 barrier_sets.acquire.emplace(barrier);
1118 }
1119 }
1120
1121 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1122 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1123 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1124 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1125 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1126 auto handle_state = BarrierHandleState(*this, barrier);
1127 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1128 if (!mode_concurrent) {
1129 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001130 cb_state->queue_submit_functions.emplace_back(
1131 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1132 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1133 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1134 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001135 });
1136 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001137 }
1138 }
1139}
1140
John Zulaufa4472282019-08-22 14:44:34 -06001141bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001142 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001143 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001144 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001145 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001146 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1147 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001148 return skip;
1149}
1150
John Zulaufa4472282019-08-22 14:44:34 -06001151void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1152 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1153 const VkImageMemoryBarrier *pImageMemBarriers) {
1154 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1155 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001156}
1157
1158template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001159bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001160 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001161 // Record to the scoreboard or report that we have a duplication
1162 bool skip = false;
1163 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1164 if (!inserted.second && inserted.first->second != cb_state) {
1165 // 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 -06001166 LogObjectList objlist(cb_state->commandBuffer);
1167 objlist.add(barrier.handle);
1168 objlist.add(inserted.first->second->commandBuffer);
1169 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001170 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1171 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1172 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1173 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1174 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001175 }
1176 return skip;
1177}
1178
1179template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001180bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1181 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001182 using BarrierRecord = QFOTransferBarrier<Barrier>;
1183 using TypeTag = typename BarrierRecord::Tag;
1184 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001185 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001186 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001187 const char *barrier_name = BarrierRecord::BarrierName();
1188 const char *handle_name = BarrierRecord::HandleName();
1189 // No release should have an extant duplicate (WARNING)
1190 for (const auto &release : cb_barriers.release) {
1191 // Check the global pending release barriers
1192 const auto set_it = global_release_barriers.find(release.handle);
1193 if (set_it != global_release_barriers.cend()) {
1194 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1195 const auto found = set_for_handle.find(release);
1196 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001197 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1198 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1199 " to dstQueueFamilyIndex %" PRIu32
1200 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1201 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1202 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001203 }
1204 }
1205 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1206 }
1207 // Each acquire must have a matching release (ERROR)
1208 for (const auto &acquire : cb_barriers.acquire) {
1209 const auto set_it = global_release_barriers.find(acquire.handle);
1210 bool matching_release_found = false;
1211 if (set_it != global_release_barriers.cend()) {
1212 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1213 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1214 }
1215 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001216 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1217 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1218 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1219 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1220 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001221 }
1222 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1223 }
1224 return skip;
1225}
1226
John Zulauf3b04ebd2019-07-18 14:08:11 -06001227bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001228 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001229 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001230 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001231 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1232 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001233 return skip;
1234}
1235
1236template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001237void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001238 using BarrierRecord = QFOTransferBarrier<Barrier>;
1239 using TypeTag = typename BarrierRecord::Tag;
1240 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001241 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001242
1243 // Add release barriers from this submit to the global map
1244 for (const auto &release : cb_barriers.release) {
1245 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1246 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1247 global_release_barriers[release.handle].insert(release);
1248 }
1249
1250 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1251 for (const auto &acquire : cb_barriers.acquire) {
1252 // NOTE: We're not using [] because we don't want to create entries for missing releases
1253 auto set_it = global_release_barriers.find(acquire.handle);
1254 if (set_it != global_release_barriers.end()) {
1255 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1256 set_for_handle.erase(acquire);
1257 if (set_for_handle.size() == 0) { // Clean up empty sets
1258 global_release_barriers.erase(set_it);
1259 }
1260 }
1261 }
1262}
1263
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001264void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001265 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1266 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001267}
1268
John Zulauf6b4aae82018-05-09 13:03:36 -06001269// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001270void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001271
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001272void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001273 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001274 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001275 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001276
Chris Forbes4de4b132017-08-21 11:27:08 -07001277 // For ownership transfers, the barrier is specified twice; as a release
1278 // operation on the yielding queue family, and as an acquire operation
1279 // on the acquiring queue family. This barrier may also include a layout
1280 // transition, which occurs 'between' the two operations. For validation
1281 // purposes it doesn't seem important which side performs the layout
1282 // transition, but it must not be performed twice. We'll arbitrarily
1283 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001284 //
1285 // However, we still need to record initial layout for the "initial layout" validation
1286 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001287
Petr Krausad0096a2019-08-09 18:35:04 +02001288 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001289 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001290 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001291 }
1292}
1293
unknown86bcb3a2019-07-11 13:05:36 -06001294void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001295 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001296 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1297 const auto &image_create_info = image_state->createInfo;
1298
1299 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1300 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1301 // for all (potential) layer sub_resources.
1302 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1303 normalized_isr.baseArrayLayer = 0;
1304 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1305 }
1306
Michael Spang8af7c102020-05-03 20:50:09 -04001307 VkImageLayout initial_layout = mem_barrier.oldLayout;
1308
1309 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001310 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001311 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1312 }
1313
John Zulauf2be3fe02019-12-30 09:48:02 -07001314 if (is_release_op) {
1315 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1316 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001317 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001318 }
unknown86bcb3a2019-07-11 13:05:36 -06001319}
1320
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001321bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1322 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1323 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1324 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001325 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001326 assert(cb_node);
1327 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001328 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001329 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001330
John Zulauff660ad62019-03-23 07:16:05 -06001331 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1332 if (subresource_map) {
1333 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001334 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001335 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1336 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001337 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001338 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1339 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1340 "%s layout %s.",
1341 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1342 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1343 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001344 }
John Zulauf5e617452019-11-19 14:44:16 -07001345 }
John Zulauff660ad62019-03-23 07:16:05 -06001346 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001347 }
John Zulauff660ad62019-03-23 07:16:05 -06001348
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001349 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1350 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1351 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001352 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1353 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001354 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1355 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1356 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001357 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001358 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001359 if (image_state->shared_presentable) {
1360 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001361 skip |=
1362 LogError(device, layout_invalid_msg_code,
1363 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1364 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001365 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001366 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001367 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001368 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001369 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1370 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1371 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1372 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001373 }
1374 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001375 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001376}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001377bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001378 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1379 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001380 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001381 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1382 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1383}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001384
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001385void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001386 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001387 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001388 if (!renderPass) return;
1389
Tobias Hectorbbb12282018-10-22 15:17:59 +01001390 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001391 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001392 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001393 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001394 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1395 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1396 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1397 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001398 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001399 }
John Zulauf8e308292018-09-21 11:34:37 -06001400 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001401 VkImageLayout stencil_layout = kInvalidLayout;
1402 const auto *attachment_description_stencil_layout =
1403 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1404 if (attachment_description_stencil_layout) {
1405 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1406 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001407 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001408 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001409 }
1410 }
1411}
Dave Houltone19e20d2018-02-02 16:32:41 -07001412
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001413#ifdef VK_USE_PLATFORM_ANDROID_KHR
1414// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1415// This could also move into a seperate core_validation_android.cpp file... ?
1416
1417//
1418// AHB-specific validation within non-AHB APIs
1419//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001420bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001421 bool skip = false;
1422
1423 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1424 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001425 if (0 != ext_fmt_android->externalFormat) {
1426 if (VK_FORMAT_UNDEFINED != create_info->format) {
1427 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001428 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1429 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1430 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001431 }
1432
1433 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001434 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1435 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1436 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001437 }
1438
1439 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001440 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1441 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001442 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1443 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1444 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001445 }
1446
1447 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001448 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1449 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1450 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001451 }
1452 }
1453
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001454 if ((0 != ext_fmt_android->externalFormat) &&
1455 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001456 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001457 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1458 ") which has "
1459 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1460 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001461 }
1462 }
1463
Dave Houltond9611312018-11-19 17:03:36 -07001464 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001465 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001466 skip |=
1467 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1468 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1469 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001470 }
1471 }
1472
1473 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1474 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1475 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001476 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001477 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1478 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1479 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1480 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001481 }
1482
1483 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001484 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1485 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1486 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1487 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1488 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001489 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001490 }
1491
1492 return skip;
1493}
1494
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001495bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001496 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001497 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001498
1499 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001500 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001501 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1502 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001503 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001504 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001505 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001506
Dave Houltond9611312018-11-19 17:03:36 -07001507 // Chain must include a compatible ycbcr conversion
1508 bool conv_found = false;
1509 uint64_t external_format = 0;
1510 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1511 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001512 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001513 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001514 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001515 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001516 }
Dave Houltond9611312018-11-19 17:03:36 -07001517 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001518 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001519 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001520 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1521 "an externalFormat (%" PRIu64
1522 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1523 "with the same external format.",
1524 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001525 }
1526
1527 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001528 if (IsIdentitySwizzle(create_info->components) == false) {
1529 skip |= LogError(
1530 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1531 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1532 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1533 "= %s.",
1534 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1535 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001536 }
1537 }
Dave Houltond9611312018-11-19 17:03:36 -07001538
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001539 return skip;
1540}
1541
John Zulaufa26d3c82019-08-14 16:09:08 -06001542bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001543 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001544
John Zulaufa26d3c82019-08-14 16:09:08 -06001545 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001546 if (image_state != nullptr) {
1547 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1548 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1549 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1550 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1551 "bound to memory.");
1552 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001553 }
1554 return skip;
1555}
1556
1557#else
1558
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001559bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001560 return false;
1561}
1562
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001563bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001564
John Zulaufa26d3c82019-08-14 16:09:08 -06001565bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001566
1567#endif // VK_USE_PLATFORM_ANDROID_KHR
1568
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001569bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1570 bool skip = false;
1571
1572 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1573 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1574 const VkImageTiling image_tiling = pCreateInfo->tiling;
1575 const VkFormat image_format = pCreateInfo->format;
1576
1577 if (image_format == VK_FORMAT_UNDEFINED) {
1578 // VU 01975 states format can't be undefined unless an android externalFormat
1579#ifdef VK_USE_PLATFORM_ANDROID_KHR
1580 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1581 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1582 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1583 if (it != ahb_ext_formats_map.end()) {
1584 tiling_features = it->second;
1585 }
1586 }
1587#endif
1588 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1589 uint64_t drm_format_modifier = 0;
1590 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1591 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1592 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1593 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1594
1595 if (drm_explicit != nullptr) {
1596 drm_format_modifier = drm_explicit->drmFormatModifier;
1597 } else {
1598 // VUID 02261 makes sure its only explict or implict in parameter checking
1599 assert(drm_implicit != nullptr);
1600 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1601 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1602 }
1603 }
1604
1605 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1606 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1607 nullptr};
1608 format_properties_2.pNext = (void *)&drm_properties_list;
1609 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001610 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1611 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1612 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1613 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001614
1615 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1616 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1617 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1618 }
1619 }
1620 } else {
1621 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1622 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1623 : format_properties.optimalTilingFeatures;
1624 }
1625
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001626 // Lack of disjoint format feature support while using the flag
1627 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1628 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1629 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1630 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1631 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1632 string_VkFormat(pCreateInfo->format));
1633 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001634
1635 return skip;
1636}
1637
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001638bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001639 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001640 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001641
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001642 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001643 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001644 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1645 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001646 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1647 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001648 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001649 }
1650
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001651 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1652 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001653 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1654 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1655 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001656 }
1657
1658 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001659 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1660 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1661 "height (%d) and arrayLayers (%d) must be >= 6.",
1662 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001663 }
Dave Houlton130c0212018-01-29 13:39:56 -07001664 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001665
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001666 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001667 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1668 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1669 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001670 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1671 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1672 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001673 }
1674
1675 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001676 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1677 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1678 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001679 }
1680
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001681 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
ByumjinConffx991b6062019-08-14 15:17:53 -07001682 uint32_t ceiling_width =
1683 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1684 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1685 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1686 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001687 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1688 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1689 "ceiling of device "
1690 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1691 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1692 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001693 }
1694
1695 uint32_t ceiling_height =
1696 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1697 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1698 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1699 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001700 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1701 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1702 "ceiling of device "
1703 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1704 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1705 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001706 }
1707 }
1708
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001709 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001710 VkResult result = VK_SUCCESS;
1711 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1712 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1713 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1714 &format_limits);
1715 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001716 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1717 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1718 if (modifier_list) {
1719 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1720 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1721 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1722 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1723 image_format_info.type = pCreateInfo->imageType;
1724 image_format_info.format = pCreateInfo->format;
1725 image_format_info.tiling = pCreateInfo->tiling;
1726 image_format_info.usage = pCreateInfo->usage;
1727 image_format_info.flags = pCreateInfo->flags;
1728 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1729
1730 result =
1731 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1732 format_limits = image_format_properties.imageFormatProperties;
1733
1734 /* The application gives a list of modifier and the driver
1735 * selects one. If one is wrong, stop there.
1736 */
1737 if (result != VK_SUCCESS) break;
1738 }
1739 } else if (explicit_modifier) {
1740 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1741 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1742 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1743 image_format_info.type = pCreateInfo->imageType;
1744 image_format_info.format = pCreateInfo->format;
1745 image_format_info.tiling = pCreateInfo->tiling;
1746 image_format_info.usage = pCreateInfo->usage;
1747 image_format_info.flags = pCreateInfo->flags;
1748 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1749
1750 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1751 format_limits = image_format_properties.imageFormatProperties;
1752 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001753 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001754
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001755 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1756 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1757 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1758 if (result != VK_SUCCESS) {
1759 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001760#ifdef VK_USE_PLATFORM_ANDROID_KHR
1761 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1762#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001763 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001764 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001765 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1766 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001767 } else {
1768 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1769 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001770 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1771 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1772 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001773 }
Dave Houlton130c0212018-01-29 13:39:56 -07001774
Dave Houltona585d132019-01-18 13:05:42 -07001775 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1776 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1777 (uint64_t)pCreateInfo->samples;
1778 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001779
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001780 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001781 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001782 uint64_t ig_mask = imageGranularity - 1;
1783 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001784
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001785 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001786 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1787 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1788 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1789 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001790 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001791
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001792 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001793 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1794 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1795 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001796 }
1797
1798 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001799 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1800 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1801 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001802 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001803
1804 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1805 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1806 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1807 pCreateInfo->extent.width, format_limits.maxExtent.width);
1808 }
1809
1810 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1811 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1812 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1813 pCreateInfo->extent.height, format_limits.maxExtent.height);
1814 }
1815
1816 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1817 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1818 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1819 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1820 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001821 }
1822
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001823 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001824 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1825 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1826 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1827 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001828 skip |= LogError(device, error_vuid,
1829 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1830 "YCbCr Conversion format, arrayLayers must be 1",
1831 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001832 }
1833
1834 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001835 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1836 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1837 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001838 }
1839
1840 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001841 skip |= LogError(
1842 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001843 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1844 string_VkSampleCountFlagBits(pCreateInfo->samples));
1845 }
1846
1847 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001848 skip |= LogError(
1849 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001850 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1851 string_VkImageType(pCreateInfo->imageType));
1852 }
1853 }
1854
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001855 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001856 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001857 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001858 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001859 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1860 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1861 "format must be block, ETC or ASTC compressed, but is %s",
1862 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001863 }
1864 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001865 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1866 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1867 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001868 }
1869 }
1870 }
1871
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001872 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001873 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1874 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
1875 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001876 }
1877
unknown2c877272019-07-11 12:56:50 -06001878 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1879 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1880 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001881 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1882 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1883 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001884 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001885
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001886 const auto swapchain_create_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1887 if (swapchain_create_info != nullptr) {
1888 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1889 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1890 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1891
1892 // Validate rest of Swapchain Image create check that require swapchain state
1893 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1894 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1895 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1896 skip |= LogError(
1897 device, vuid,
1898 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1899 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1900 }
1901 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1902 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1903 skip |= LogError(device, vuid,
1904 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1905 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1906 }
1907 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR);
1908 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1909 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1910 skip |= LogError(device, vuid,
1911 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1912 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
1913 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR flags both set.");
1914 }
1915 }
1916 }
1917
sfricke-samsungedce77a2020-07-03 22:35:13 -07001918 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1919 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1920 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1921 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1922 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1923 }
1924 const VkImageCreateFlags invalid_flags =
1925 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1926 if ((pCreateInfo->flags & invalid_flags) != 0) {
1927 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1928 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1929 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1930 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1931 }
1932 }
1933
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001934 skip |= ValidateImageFormatFeatures(pCreateInfo);
1935
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001936 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001937}
1938
John Zulauf7eeb6f72019-06-17 11:56:36 -06001939void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1940 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1941 if (VK_SUCCESS != result) return;
1942
1943 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001944 auto image_state = Get<IMAGE_STATE>(*pImage);
1945 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001946}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001947
Jeff Bolz5c801d12019-10-09 10:38:45 -05001948bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001949 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001950 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001951 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001952 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001953 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001954 }
1955 return skip;
1956}
1957
John Zulauf7eeb6f72019-06-17 11:56:36 -06001958void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1959 // Clean up validation specific data
1960 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001961
locke-lunargcba7d5f2019-12-30 16:59:11 -07001962 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001963
1964 // Clean up generic image state
1965 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001966}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001967
sfricke-samsungcd924d92020-05-20 23:51:17 -07001968bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
1969 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001970 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07001971 const VkImage image = image_state->image;
1972 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001973
1974 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001975 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
1976 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001977 }
1978
sfricke-samsungcd924d92020-05-20 23:51:17 -07001979 if (FormatIsDepthOrStencil(format)) {
1980 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1981 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
1982 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
1983 } else if (FormatIsCompressed(format)) {
1984 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1985 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
1986 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001987 }
1988
1989 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001990 skip |=
1991 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
1992 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
1993 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001994 }
1995 return skip;
1996}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001997
John Zulauf07288512019-07-05 11:09:50 -06001998bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1999 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2000 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002001 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002002 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2003 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002004 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2005 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2006 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002007 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002008
2009 } else {
2010 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2011 if (!device_extensions.vk_khr_shared_presentable_image) {
2012 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002013 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2014 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2015 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002016 }
2017 } else {
2018 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2019 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002020 skip |= LogError(
2021 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002022 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2023 func_name, string_VkImageLayout(dest_image_layout));
2024 }
2025 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002026 }
2027
John Zulauff660ad62019-03-23 07:16:05 -06002028 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002029 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002030 if (subresource_map) {
2031 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002032 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002033 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07002034 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
2035 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002036 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2037 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2038 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2039 } else {
2040 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002041 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002042 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2043 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2044 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2045 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002046 }
John Zulauf5e617452019-11-19 14:44:16 -07002047 }
John Zulauff660ad62019-03-23 07:16:05 -06002048 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002049 }
2050
2051 return skip;
2052}
2053
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002054bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2055 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002056 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002057 bool skip = false;
2058 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002059 const auto *cb_node = GetCBState(commandBuffer);
2060 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002061 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002062 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002063 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002064 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002065 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002066 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002067 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2068 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002069 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002070 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002071 skip |=
2072 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2073 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2074 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002075 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002076 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002077 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002078 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002079 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002080 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002081 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2082 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2083 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2084 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2085 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2086 string_VkFormat(image_state->createInfo.format));
2087 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002088 }
2089 return skip;
2090}
2091
John Zulaufeabb4462019-07-05 14:13:03 -06002092void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2093 const VkClearColorValue *pColor, uint32_t rangeCount,
2094 const VkImageSubresourceRange *pRanges) {
2095 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2096
2097 auto cb_node = GetCBState(commandBuffer);
2098 auto image_state = GetImageState(image);
2099 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002100 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002101 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002102 }
2103 }
2104}
2105
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002106bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2107 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002108 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002109 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002110
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002111 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002112 const auto *cb_node = GetCBState(commandBuffer);
2113 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002114 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002115 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002116 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002117 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002118 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002119 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002120 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002121 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002122 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002123 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002124 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002125 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002126 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2127 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2128 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2129 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002130
2131 bool any_include_aspect_depth_bit = false;
2132 bool any_include_aspect_stencil_bit = false;
2133
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002134 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002135 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002136 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002137 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002138 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002139 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2140 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002141 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2142 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2143 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2144 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002145 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002146 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2147 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002148 if (FormatHasDepth(image_format) == false) {
2149 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2150 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2151 "doesn't have a depth component.",
2152 i, string_VkFormat(image_format));
2153 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002154 }
2155 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2156 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002157 if (FormatHasStencil(image_format) == false) {
2158 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2159 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2160 "%s doesn't have a stencil component.",
2161 i, string_VkFormat(image_format));
2162 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002163 }
2164 }
2165 if (any_include_aspect_stencil_bit) {
2166 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2167 if (image_stencil_struct != nullptr) {
2168 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2169 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002170 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2171 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2172 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2173 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002174 }
2175 } else {
2176 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002177 skip |= LogError(
2178 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002179 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2180 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2181 "in VkImageCreateInfo::usage used to create image");
2182 }
2183 }
2184 }
2185 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002186 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2187 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2188 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002189 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002190 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002191 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2192 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002193 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002194 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002195 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002196 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2197 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2198 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2199 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002200 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002201 }
2202 return skip;
2203}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002204
John Zulaufeabb4462019-07-05 14:13:03 -06002205void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2206 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2207 const VkImageSubresourceRange *pRanges) {
2208 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2209 auto cb_node = GetCBState(commandBuffer);
2210 auto image_state = GetImageState(image);
2211 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002212 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002213 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002214 }
2215 }
2216}
2217
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002218// Returns true if [x, xoffset] and [y, yoffset] overlap
2219static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2220 bool result = false;
2221 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2222 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2223
2224 if (intersection_max > intersection_min) {
2225 result = true;
2226 }
2227 return result;
2228}
2229
Jeff Leger178b1e52020-10-05 12:22:23 -04002230// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002231// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002232template <typename RegionType>
2233static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002234 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002235
Dave Houltonc991cc92018-03-06 11:08:51 -07002236 // Separate planes within a multiplane image cannot intersect
2237 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002238 return result;
2239 }
2240
Dave Houltonc991cc92018-03-06 11:08:51 -07002241 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2242 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2243 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002244 result = true;
2245 switch (type) {
2246 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002247 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002248 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002249 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002250 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002251 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002252 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002253 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002254 break;
2255 default:
2256 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2257 assert(false);
2258 }
2259 }
2260 return result;
2261}
2262
Dave Houltonfc1a4052017-04-27 14:32:45 -06002263// Returns non-zero if offset and extent exceed image extents
2264static const uint32_t x_bit = 1;
2265static const uint32_t y_bit = 2;
2266static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002267static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002268 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002269 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002270 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2271 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002272 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002273 }
2274 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2275 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002276 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002277 }
2278 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2279 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002280 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002281 }
2282 return result;
2283}
2284
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002285// Test if two VkExtent3D structs are equivalent
2286static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2287 bool result = true;
2288 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2289 (extent->depth != other_extent->depth)) {
2290 result = false;
2291 }
2292 return result;
2293}
2294
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002295// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002296static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002297 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2298}
2299
2300// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002301VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002302 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2303 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002304 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002305 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002306 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002307 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002308 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002309 granularity.width *= block_size.width;
2310 granularity.height *= block_size.height;
2311 }
2312 }
2313 return granularity;
2314}
2315
2316// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2317static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2318 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002319 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2320 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002321 valid = false;
2322 }
2323 return valid;
2324}
2325
2326// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002327bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002328 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002329 bool skip = false;
2330 VkExtent3D offset_extent = {};
2331 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2332 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2333 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002334 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002335 // 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 -07002336 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002337 skip |= LogError(cb_node->commandBuffer, vuid,
2338 "%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 "
2339 "image transfer granularity is (w=0, h=0, d=0).",
2340 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002341 }
2342 } else {
2343 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2344 // integer multiples of the image transfer granularity.
2345 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002346 skip |= LogError(cb_node->commandBuffer, vuid,
2347 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2348 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2349 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2350 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002351 }
2352 }
2353 return skip;
2354}
2355
2356// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002357bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002358 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002359 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002360 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002361 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002362 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2363 // subresource extent.
2364 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002365 skip |= LogError(cb_node->commandBuffer, vuid,
2366 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2367 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2368 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2369 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002370 }
2371 } else {
2372 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2373 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2374 // subresource extent dimensions.
2375 VkExtent3D offset_extent_sum = {};
2376 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2377 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2378 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002379 bool x_ok = true;
2380 bool y_ok = true;
2381 bool z_ok = true;
2382 switch (image_type) {
2383 case VK_IMAGE_TYPE_3D:
2384 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2385 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002386 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002387 case VK_IMAGE_TYPE_2D:
2388 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2389 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002390 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002391 case VK_IMAGE_TYPE_1D:
2392 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2393 (subresource_extent->width == offset_extent_sum.width));
2394 break;
2395 default:
2396 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2397 assert(false);
2398 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002399 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002400 skip |=
2401 LogError(cb_node->commandBuffer, vuid,
2402 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2403 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2404 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2405 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2406 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2407 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002408 }
2409 }
2410 return skip;
2411}
2412
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002413bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002414 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002415 bool skip = false;
2416 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002417 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2418 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002419 }
2420 return skip;
2421}
2422
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002423bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002424 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002425 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002426 bool skip = false;
2427 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2428 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002429 skip |= LogError(cb_node->commandBuffer, vuid,
2430 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2431 "%u, but provided %s has %u array layers.",
2432 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2433 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002434 }
2435 return skip;
2436}
2437
Jeff Leger178b1e52020-10-05 12:22:23 -04002438// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2439template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002440bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002441 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002442 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002443 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002444 VkExtent3D granularity = GetScaledItg(cb_node, img);
2445 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002446 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002447 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002448 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002449 return skip;
2450}
2451
Jeff Leger178b1e52020-10-05 12:22:23 -04002452// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2453template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002454bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002455 const IMAGE_STATE *dst_img, const RegionType *region,
2456 const uint32_t i, const char *function,
2457 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002458 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002459 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2460 const char *vuid;
2461
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002462 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002463 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002464 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2465 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002466 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002467 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002468 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002469 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002470 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002471
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002472 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002473 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002474 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2475 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002476 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002477 const VkExtent3D dest_effective_extent =
2478 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002479 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002480 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002481 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002482 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002483 return skip;
2484}
2485
Jeff Leger178b1e52020-10-05 12:22:23 -04002486// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2487template <typename ImageCopyRegionType>
2488bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2489 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2490 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002491 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002492 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2493 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2494 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002495
2496 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002497 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002498
2499 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002500 const VkExtent3D src_copy_extent = region.extent;
2501 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002502 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2503
Dave Houlton6f9059e2017-05-02 17:15:13 -06002504 bool slice_override = false;
2505 uint32_t depth_slices = 0;
2506
2507 // Special case for copying between a 1D/2D array and a 3D image
2508 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2509 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002510 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002511 slice_override = (depth_slices != 1);
2512 } 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 -07002513 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002514 slice_override = (depth_slices != 1);
2515 }
2516
2517 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002518 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002519 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002520 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2521 skip |= LogError(src_state->image, vuid,
2522 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2523 "be 0 and 1, respectively.",
2524 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002525 }
2526 }
2527
Dave Houlton533be9f2018-03-26 17:08:30 -06002528 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002529 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2530 skip |= LogError(src_state->image, vuid,
2531 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002532 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002533 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002534 }
2535
Dave Houlton533be9f2018-03-26 17:08:30 -06002536 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002537 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2538 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2539 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002540 }
2541
Dave Houltonc991cc92018-03-06 11:08:51 -07002542 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002543 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002544 if (FormatIsCompressed(src_state->createInfo.format) ||
2545 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002546 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002547 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002548 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2549 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2550 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002551 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002552 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002553 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002554 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002555 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002556 }
2557
Dave Houlton94a00372017-12-14 15:08:47 -07002558 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002559 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2560 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002561 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2562 skip |= LogError(src_state->image, vuid,
2563 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2564 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2565 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002566 }
2567
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002568 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002569 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2570 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002571 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2572 skip |= LogError(src_state->image, vuid,
2573 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2574 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2575 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002576 }
2577
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002578 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002579 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2580 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002581 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2582 skip |= LogError(src_state->image, vuid,
2583 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2584 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2585 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002586 }
2587 } // Compressed
2588
2589 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002590 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002591 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002592 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2593 skip |= LogError(dst_state->image, vuid,
2594 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002595 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002596 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002597 }
2598 }
2599
Dave Houlton533be9f2018-03-26 17:08:30 -06002600 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002601 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2602 skip |= LogError(dst_state->image, vuid,
2603 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2604 "and 1, respectively.",
2605 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002606 }
2607
Dave Houlton533be9f2018-03-26 17:08:30 -06002608 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002609 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2610 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2611 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002612 }
2613
sfricke-samsung30b094c2020-05-30 11:42:11 -07002614 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002615 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002616 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2617 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002618 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
2619 skip |= LogError(src_state->image, vuid,
2620 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2621 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2622 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002623 }
2624 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002625 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002626 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002627 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
2628 skip |= LogError(dst_state->image, vuid,
2629 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2630 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2631 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002632 }
2633 }
2634 } else { // Pre maint 1
2635 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002636 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002637 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2638 skip |= LogError(src_state->image, vuid,
2639 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002640 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2641 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002642 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002643 }
Dave Houltonee281a52017-12-08 13:51:02 -07002644 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002645 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2646 skip |= LogError(dst_state->image, vuid,
2647 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002648 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2649 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002650 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002651 }
2652 }
2653 }
2654
Dave Houltonc991cc92018-03-06 11:08:51 -07002655 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2656 if (FormatIsCompressed(dst_state->createInfo.format) ||
2657 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002658 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002659
2660 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002661 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2662 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2663 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002664 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002665 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002666 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002667 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002668 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002669 }
2670
Dave Houlton94a00372017-12-14 15:08:47 -07002671 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002672 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2673 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002674 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
2675 skip |= LogError(dst_state->image, vuid,
2676 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2677 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2678 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002679 }
2680
Dave Houltonee281a52017-12-08 13:51:02 -07002681 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2682 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2683 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002684 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002685 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002686 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002687 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2688 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002689 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002690 }
2691
Dave Houltonee281a52017-12-08 13:51:02 -07002692 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2693 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2694 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002695 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
2696 skip |= LogError(dst_state->image, vuid,
2697 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2698 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2699 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002700 }
2701 } // Compressed
2702 }
2703 return skip;
2704}
2705
Jeff Leger178b1e52020-10-05 12:22:23 -04002706// vkCmdCopyImage / vmCmdCopyImage2KHR checks that only apply if the multiplane extension is enabled
2707template <typename RegionType>
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002708bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04002709 const IMAGE_STATE *dst_image_state, const RegionType region,
2710 CopyCommandVersion version) const {
2711 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Dave Houltonc991cc92018-03-06 11:08:51 -07002712 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002713
Jeff Leger178b1e52020-10-05 12:22:23 -04002714 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2715 const char *vuid;
2716
Dave Houltonc991cc92018-03-06 11:08:51 -07002717 // Neither image is multiplane
2718 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2719 // If neither image is multi-plane the aspectMask member of src and dst must match
2720 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2721 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002722 ss << func_name << ": Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002723 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Jeff Leger178b1e52020-10-05 12:22:23 -04002724 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2725 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002726 }
2727 } else {
2728 // Source image multiplane checks
2729 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2730 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2731 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2732 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002733 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2734 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2735 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002736 }
2737 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2738 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2739 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002740 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2741 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2742 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002743 }
2744 // Single-plane to multi-plane
2745 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2746 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2747 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002748 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2749 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2750 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002751 }
2752
2753 // Dest image multiplane checks
2754 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2755 aspect = region.dstSubresource.aspectMask;
2756 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2757 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002758 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2759 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2760 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002761 }
2762 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2763 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2764 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002765 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2766 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2767 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002768 }
2769 // Multi-plane to single-plane
2770 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2771 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2772 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002773 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2774 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
2775 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002776 }
2777 }
2778
2779 return skip;
2780}
2781
Jeff Leger178b1e52020-10-05 12:22:23 -04002782template <typename RegionType>
2783bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2784 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2785 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002786 const auto *cb_node = GetCBState(commandBuffer);
2787 const auto *src_image_state = GetImageState(srcImage);
2788 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002789 const VkFormat src_format = src_image_state->createInfo.format;
2790 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002791 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002792 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002793
Jeff Leger178b1e52020-10-05 12:22:23 -04002794 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2795 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2796 const char *vuid;
2797
2798 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002799
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002800 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2801
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002802 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002803 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002804
2805 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2806 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002807 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002808
Dave Houlton6f9059e2017-05-02 17:15:13 -06002809 bool slice_override = false;
2810 uint32_t depth_slices = 0;
2811
2812 // Special case for copying between a 1D/2D array and a 3D image
2813 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2814 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2815 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002816 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002817 slice_override = (depth_slices != 1);
2818 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2819 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002820 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002821 slice_override = (depth_slices != 1);
2822 }
2823
Jeff Leger178b1e52020-10-05 12:22:23 -04002824 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2825 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2826 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2827 skip |=
2828 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2829 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2830 skip |=
2831 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2832 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002833 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002834 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2835 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002836 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002837 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002838
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002839 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002840 // No chance of mismatch if we're overriding depth slice count
2841 if (!slice_override) {
2842 // The number of depth slices in srcSubresource and dstSubresource must match
2843 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2844 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002845 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2846 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002847 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002848 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2849 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002850 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002851 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2852 skip |= LogError(command_buffer, vuid,
2853 "%s: number of depth slices in source and destination subresources for "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002854 "pRegions[%u] do not match.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002855 func_name, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002856 }
2857 }
2858 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002859 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002860 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002861 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
2862 skip |= LogError(command_buffer, vuid,
2863 "%s: number of layers in source and destination subresources for pRegions[%u] do not match",
2864 func_name, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002865 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002866 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002867
Dave Houltonc991cc92018-03-06 11:08:51 -07002868 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002869 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002870 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region, version);
Dave Houltonc991cc92018-03-06 11:08:51 -07002871 }
2872
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002873 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002874 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2875 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002876 std::stringstream ss;
2877 ss << func_name << ": Src and dest aspectMasks for each region must match";
2878 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
2879 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonf5217612018-02-02 16:18:52 -07002880 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002881 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002882
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002883 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002884 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002885 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002886 ss << func_name << ": pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002887 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Jeff Leger178b1e52020-10-05 12:22:23 -04002888 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
2889 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002890 }
2891
2892 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002893 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002894 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002895 ss << func_name << ": pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2896 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
2897 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002898 }
2899
Dave Houltonfc1a4052017-04-27 14:32:45 -06002900 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002901 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2902 if (slice_override) src_copy_extent.depth = depth_slices;
2903 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002904 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002905 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
2906 skip |= LogError(command_buffer, vuid,
2907 "%s: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2908 "width [%1d].",
2909 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002910 }
2911
2912 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002913 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
2914 skip |= LogError(command_buffer, vuid,
2915 "%s: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2916 "height [%1d].",
2917 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002918 }
2919 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002920 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
2921 skip |= LogError(command_buffer, vuid,
2922 "%s: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2923 "depth [%1d].",
2924 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002925 }
2926
Dave Houltonee281a52017-12-08 13:51:02 -07002927 // Adjust dest extent if necessary
2928 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2929 if (slice_override) dst_copy_extent.depth = depth_slices;
2930
2931 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002932 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002933 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
2934 skip |= LogError(command_buffer, vuid,
2935 "%s: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002936 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002937 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002938 }
2939 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002940 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
2941 skip |= LogError(command_buffer, vuid,
2942 "%s): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002943 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002944 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002945 }
2946 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002947 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
2948 skip |= LogError(command_buffer, vuid,
2949 "%s: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002950 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002951 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002952 }
2953
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002954 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2955 // must not overlap in memory
2956 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002957 for (uint32_t j = 0; j < regionCount; j++) {
2958 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002959 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002960 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002961 ss << func_name << ": pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2962 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
2963 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002964 }
2965 }
2966 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002967
2968 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2969 if (device_extensions.vk_khr_maintenance1) {
2970 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2971 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2972 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002973 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
2974 skip |= LogError(command_buffer, vuid,
2975 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
2976 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08002977 }
2978 } else {
2979 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2980 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2981 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002982 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
2983 skip |= LogError(command_buffer, vuid,
2984 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
2985 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08002986 }
2987 }
2988
2989 // Check if 2D with 3D and depth not equal to 2D layerCount
2990 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2991 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2992 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002993 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
2994 skip |= LogError(command_buffer, vuid,
2995 "%s: pRegion[%u] srcImage is 2D, dstImage is 3D and extent.depth is %u and has to be "
sfricke-samsung48172ca2020-02-13 23:38:11 -08002996 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04002997 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08002998 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2999 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3000 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003001 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3002 skip |= LogError(command_buffer, vuid,
3003 "%s: pRegion[%u] srcImage is 3D, dstImage is 2D and extent.depth is %u and has to be "
sfricke-samsung48172ca2020-02-13 23:38:11 -08003004 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003005 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003006 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003007
3008 // Check for multi-plane format compatiblity
3009 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3010 size_t src_format_size = 0;
3011 size_t dst_format_size = 0;
3012 if (FormatIsMultiplane(src_format)) {
3013 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3014 src_format_size = FormatElementSize(planeFormat);
3015 } else {
3016 src_format_size = FormatElementSize(src_format);
3017 }
3018 if (FormatIsMultiplane(dst_format)) {
3019 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3020 dst_format_size = FormatElementSize(planeFormat);
3021 } else {
3022 dst_format_size = FormatElementSize(dst_format);
3023 }
3024 // If size is still zero, then format is invalid and will be caught in another VU
3025 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003026 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3027 skip |= LogError(command_buffer, vuid,
3028 "%s: pRegions[%u] called with non-compatible image formats. "
3029 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3030 func_name, i, string_VkFormat(src_format),
3031 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3032 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003033 }
3034 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003035 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003036
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003037 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3038 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3039 // because because both texels are 4 bytes in size.
3040 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003041 const char *compatible_vuid =
3042 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3043 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3044 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003045 // Depth/stencil formats must match exactly.
3046 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3047 if (src_format != dst_format) {
3048 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003049 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003050 string_VkFormat(src_format), string_VkFormat(dst_format));
3051 }
3052 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003053 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003054 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003055 "%s: Unmatched image format sizes. "
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003056 "The src format %s has size of %zu and dst format %s has size of %zu.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003057 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003058 FormatElementSize(dst_format));
3059 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003060 }
3061 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003062
Dave Houlton33c22b72017-02-28 13:16:02 -07003063 // Source and dest image sample counts must match
3064 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003065 std::stringstream ss;
3066 ss << func_name << " called on image pair with non-identical sample counts.";
3067 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
3068 skip |= LogError(command_buffer, vuid, "%s", ss.str().c_str());
Dave Houlton33c22b72017-02-28 13:16:02 -07003069 }
3070
Jeff Leger178b1e52020-10-05 12:22:23 -04003071 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127";
3072 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3073 vuid = is_2khr ? "" : "";
3074 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003075 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003076 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3077 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3078 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3079 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3080 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3081 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3082 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3083 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3084 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3085 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3086 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3087 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003088
3089 // Validation for VK_EXT_fragment_density_map
3090 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003091 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3092 skip |=
3093 LogError(command_buffer, vuid,
3094 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT", func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003095 }
3096 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003097 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3098 skip |=
3099 LogError(command_buffer, vuid,
3100 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT", func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003101 }
3102
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003103 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003104 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3105 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3106 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3107 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003108 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003109 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImage-commandBuffer-cmdpool";
3110 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
3111 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3112 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-renderpass" : "VUID-vkCmdCopyImage-renderpass";
3113 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003114 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003115
3116 const char *invalid_src_layout_vuid =
3117 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3118 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3119 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3120 const char *invalid_dst_layout_vuid =
3121 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3122 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3123 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3124
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003125 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003126 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003127 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003128 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3129 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003130 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003131 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003132 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003133 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003134 }
3135
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003136 return skip;
3137}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003138
Jeff Leger178b1e52020-10-05 12:22:23 -04003139bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3140 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3141 const VkImageCopy *pRegions) const {
3142 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3143 COPY_COMMAND_VERSION_1);
3144}
3145
3146bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3147 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3148 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3149 COPY_COMMAND_VERSION_2);
3150}
3151
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003152void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3153 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3154 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003155 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3156 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003157 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003158 auto src_image_state = GetImageState(srcImage);
3159 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003160
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003161 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003162 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003163 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3164 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003165 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003166}
3167
Jeff Leger178b1e52020-10-05 12:22:23 -04003168void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3169 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3170 auto cb_node = GetCBState(commandBuffer);
3171 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3172 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3173
3174 // Make sure that all image slices are updated to correct layout
3175 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3176 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3177 pCopyImageInfo->srcImageLayout);
3178 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3179 pCopyImageInfo->dstImageLayout);
3180 }
3181}
3182
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003183// Returns true if sub_rect is entirely contained within rect
3184static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3185 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
3186 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
3187 return false;
3188 return true;
3189}
3190
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003191bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003192 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
3193 const VkRect2D &render_area, uint32_t rect_count,
3194 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003195 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003196 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3197 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06003198 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07003199 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003200
3201 for (uint32_t j = 0; j < rect_count; j++) {
3202 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003203 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3204 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3205 "the current render pass instance.",
3206 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003207 }
3208
3209 if (image_view_state) {
3210 // The layers specified by a given element of pRects must be contained within every attachment that
3211 // pAttachments refers to
3212 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3213 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3214 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003215 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3216 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3217 "of pAttachment[%d].",
3218 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003219 }
3220 }
3221 }
3222 return skip;
3223}
3224
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003225bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3226 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003227 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003228 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003229 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003230 if (!cb_node) return skip;
3231
3232 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3233 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3234 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003235 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003236
3237 // Validate that attachment is in reference list of active subpass
3238 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003239 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003240 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003241 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003242 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003243 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003244
John Zulauf3a548ef2019-02-01 16:14:07 -07003245 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3246 auto clear_desc = &pAttachments[attachment_index];
3247 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003248
sfricke-samsung01f7db92020-10-21 00:28:44 -07003249 if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003250 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003251 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003252 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3253 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3254 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3255 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003256 skip |= LogError(
3257 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3258 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3259 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3260 attachment_index, clear_desc->colorAttachment,
3261 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3262 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003263
John Zulauff2582972019-02-09 14:53:30 -07003264 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3265 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003266 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003267 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3268 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3269 " subpass %u. colorAttachmentCount=%u",
3270 attachment_index, clear_desc->colorAttachment,
3271 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3272 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003273 }
John Zulauff2582972019-02-09 14:53:30 -07003274 fb_attachment = color_attachment;
3275
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003276 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3277 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3278 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003279 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003280 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003281 }
3282 } else { // Must be depth and/or stencil
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003283 if (!subpass_desc->pDepthStencilAttachment ||
3284 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003285 skip |= LogPerformanceWarning(
3286 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003287 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003288 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003289 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003290 }
3291 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003292 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003293 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3294 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003295 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003296
3297 // Once the framebuffer attachment is found, can get the image view state
3298 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3299 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3300 const IMAGE_VIEW_STATE *image_view_state =
3301 GetAttachmentImageViewState(GetCBState(commandBuffer), framebuffer, fb_attachment);
3302 if (image_view_state != nullptr) {
3303 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3304 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3305 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3306 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3307 }
3308 }
John Zulauf441558b2019-08-12 11:47:39 -06003309 }
3310 }
3311 return skip;
3312}
3313
3314void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3315 const VkClearAttachment *pAttachments, uint32_t rectCount,
3316 const VkClearRect *pRects) {
3317 auto *cb_node = GetCBState(commandBuffer);
3318 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3319 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3320 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3321 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3322 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3323 const auto clear_desc = &pAttachments[attachment_index];
3324 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3325 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3326 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3327 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3328 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3329 subpass_desc->pDepthStencilAttachment) {
3330 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3331 }
3332 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003333 if (!clear_rect_copy) {
3334 // We need a copy of the clear rectangles that will persist until the last lambda executes
3335 // but we want to create it as lazily as possible
3336 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003337 }
John Zulauf441558b2019-08-12 11:47:39 -06003338 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3339 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003340 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003341 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003342 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003343 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3344 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003345 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
3346 clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003347 return skip;
3348 };
3349 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003350 }
3351 }
3352 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003353}
3354
Jeff Leger178b1e52020-10-05 12:22:23 -04003355template <typename RegionType>
3356bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3357 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3358 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003359 const auto *cb_node = GetCBState(commandBuffer);
3360 const auto *src_image_state = GetImageState(srcImage);
3361 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003362 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3363 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3364 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3365 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003366
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003367 bool skip = false;
3368 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003369 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3370 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3371 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3372 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3373 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdResolveImage-commandBuffer-cmdpool";
3374 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3375 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3376 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-renderpass" : "VUID-vkCmdResolveImage-renderpass";
3377 skip |= InsideRenderPass(cb_node, func_name, vuid);
3378 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3379 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3380 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3381 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3382 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3383 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3384 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3385 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003386
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003387 // Validation for VK_EXT_fragment_density_map
3388 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003389 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3390 skip |= LogError(cb_node->commandBuffer, vuid,
3391 "%s: srcImage must not have been created with flags containing "
3392 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3393 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003394 }
3395 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003396 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3397 skip |= LogError(cb_node->commandBuffer, vuid,
3398 "%s: dstImage must not have been created with flags containing "
3399 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3400 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003401 }
3402
Cort Stratton7df30962018-05-17 19:45:57 -07003403 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003404 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003405 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3406 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003407 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003408 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3409 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3410 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003411 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003412 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3413 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3414 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3415 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3416 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3417 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003418 // For each region, the number of layers in the image subresource should not be zero
3419 // For each region, src and dest image aspect must be color only
3420 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003421 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003422 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3423 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003424 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3425 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3426 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003427 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003428 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3429 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003430 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003431 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3432 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3433 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3434 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3435 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3436 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003437 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003438 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3439 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003440 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003441 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003442
3443 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003444 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003445 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3446 skip |=
3447 LogError(cb_node->commandBuffer, vuid,
3448 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003449 }
Cort Stratton7df30962018-05-17 19:45:57 -07003450 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003451 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3452 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003453 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3454 skip |= LogError(cb_node->commandBuffer, vuid,
3455 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3456 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003457 }
3458
3459 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3460 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3461
3462 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003463 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003464 LogObjectList objlist(cb_node->commandBuffer);
3465 objlist.add(src_image_state->image);
3466 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003467 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3468 skip |= LogError(objlist, vuid,
3469 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003470 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003471 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003472 }
3473 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3474 LogObjectList objlist(cb_node->commandBuffer);
3475 objlist.add(src_image_state->image);
3476 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003477 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3478 skip |= LogError(objlist, vuid,
3479 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003480 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003481 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003482 }
3483 }
3484
3485 if (VK_IMAGE_TYPE_1D == src_image_type) {
3486 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3487 LogObjectList objlist(cb_node->commandBuffer);
3488 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003489 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3490 skip |= LogError(objlist, vuid,
3491 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003492 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003493 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3494 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003495 }
3496 }
3497 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3498 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3499 LogObjectList objlist(cb_node->commandBuffer);
3500 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003501 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3502 skip |= LogError(objlist, vuid,
3503 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003504 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003505 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3506 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003507 }
3508 }
3509
3510 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3511 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3512 LogObjectList objlist(cb_node->commandBuffer);
3513 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003514 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3515 skip |= LogError(objlist, vuid,
3516 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003517 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003518 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3519 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003520 }
3521 }
3522 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3523 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3524 LogObjectList objlist(cb_node->commandBuffer);
3525 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003526 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3527 skip |= LogError(objlist, vuid,
3528 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003529 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003530 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3531 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003532 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003533 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003534
3535 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3536 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3537 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3538 // developer
3539 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3540 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
3541 if ((extent_check & x_bit) != 0) {
3542 LogObjectList objlist(cb_node->commandBuffer);
3543 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003544 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3545 skip |= LogError(objlist, vuid,
3546 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003547 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003548 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003549 region.extent.width, subresource_extent.width);
3550 }
3551
3552 if ((extent_check & y_bit) != 0) {
3553 LogObjectList objlist(cb_node->commandBuffer);
3554 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003555 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3556 skip |= LogError(objlist, vuid,
3557 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003558 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003559 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003560 region.extent.height, subresource_extent.height);
3561 }
3562
3563 if ((extent_check & z_bit) != 0) {
3564 LogObjectList objlist(cb_node->commandBuffer);
3565 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003566 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3567 skip |= LogError(objlist, vuid,
3568 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003569 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003570 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003571 region.extent.depth, subresource_extent.depth);
3572 }
3573 }
3574
3575 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3576 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3577 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3578 // developer
3579 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3580 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
3581 if ((extent_check & x_bit) != 0) {
3582 LogObjectList objlist(cb_node->commandBuffer);
3583 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003584 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3585 skip |= LogError(objlist, vuid,
3586 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003587 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003588 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003589 region.extent.width, subresource_extent.width);
3590 }
3591
3592 if ((extent_check & y_bit) != 0) {
3593 LogObjectList objlist(cb_node->commandBuffer);
3594 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003595 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3596 skip |= LogError(objlist, vuid,
3597 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003598 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003599 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003600 region.extent.height, subresource_extent.height);
3601 }
3602
3603 if ((extent_check & z_bit) != 0) {
3604 LogObjectList objlist(cb_node->commandBuffer);
3605 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003606 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3607 skip |= LogError(objlist, vuid,
3608 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003609 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003610 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003611 region.extent.depth, subresource_extent.depth);
3612 }
3613 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003614 }
3615
3616 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003617 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
3618 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
3619 func_name, string_VkFormat(src_image_state->createInfo.format),
3620 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003621 }
3622 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003623 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003624 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003625 string_VkImageType(src_image_state->createInfo.imageType),
3626 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003627 }
3628 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003629 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
3630 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage sample count is VK_SAMPLE_COUNT_1_BIT.", func_name);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003631 }
3632 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003633 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
3634 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3635 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003636 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003637 } else {
3638 assert(0);
3639 }
3640 return skip;
3641}
3642
Jeff Leger178b1e52020-10-05 12:22:23 -04003643bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3644 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3645 const VkImageResolve *pRegions) const {
3646 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3647 COPY_COMMAND_VERSION_1);
3648}
3649
3650bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3651 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3652 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3653 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3654 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3655}
3656
3657template <typename RegionType>
3658bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3659 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3660 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003661 const auto *cb_node = GetCBState(commandBuffer);
3662 const auto *src_image_state = GetImageState(srcImage);
3663 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003664
Jeff Leger178b1e52020-10-05 12:22:23 -04003665 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3666 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3667 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3668
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003669 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003670 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003671 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003672 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003673 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003674 const char *vuid;
3675 const char *location;
3676 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3677 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3678 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3679 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3680 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3681 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3682 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3683 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3684 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3685 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3686 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3687 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3688 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3689 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3690 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3691 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3692 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdBlitImage-commandBuffer-cmdpool";
3693 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3694 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3695 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-renderpass" : "VUID-vkCmdBlitImage-renderpass";
3696 skip |= InsideRenderPass(cb_node, func_name, vuid);
3697 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3698 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3699 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3700 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3701 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3702 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3703 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3704 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3705 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3706 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003707
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003708 // Validation for VK_EXT_fragment_density_map
3709 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003710 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3711 skip |= LogError(cb_node->commandBuffer, vuid,
3712 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3713 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003714 }
3715 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003716 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3717 skip |= LogError(cb_node->commandBuffer, vuid,
3718 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3719 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003720 }
3721
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003722 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003723
Dave Houlton33c2d252017-06-09 17:08:32 -06003724 VkFormat src_format = src_image_state->createInfo.format;
3725 VkFormat dst_format = dst_image_state->createInfo.format;
3726 VkImageType src_type = src_image_state->createInfo.imageType;
3727 VkImageType dst_type = dst_image_state->createInfo.imageType;
3728
Cort Stratton186b1a22018-05-01 20:18:06 -04003729 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003730 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3731 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3732 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003733 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003734 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003735 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003736 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003737 }
3738
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003739 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003740 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3741 skip |= LogError(device, vuid,
3742 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003743 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003744 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003745 }
3746
3747 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003748 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
3749 skip |= LogError(device, vuid,
3750 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003751 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003752 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003753 }
3754
Dave Houlton33c2d252017-06-09 17:08:32 -06003755 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003756 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
3757 skip |= LogError(cb_node->commandBuffer, vuid,
3758 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003759 }
3760
Dave Houlton33c2d252017-06-09 17:08:32 -06003761 // Validate consistency for unsigned formats
3762 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3763 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003764 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003765 << "the other one must also have unsigned integer format. "
3766 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003767 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
3768 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003769 }
3770
3771 // Validate consistency for signed formats
3772 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3773 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003774 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003775 << "the other one must also have signed integer format. "
3776 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003777 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
3778 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003779 }
3780
3781 // Validate filter for Depth/Stencil formats
3782 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3783 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003784 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003785 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003786 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
3787 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003788 }
3789
3790 // Validate aspect bits and formats for depth/stencil images
3791 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3792 if (src_format != dst_format) {
3793 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003794 ss << func_name << ": If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003795 << "stencil, the other one must have exactly the same format. "
3796 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3797 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003798 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
3799 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003800 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003801 } // Depth or Stencil
3802
3803 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003804 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003805 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3806 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
3807 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
3808 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3809 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3810 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003811 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003812 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3813 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
3814 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
3815 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3816 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3817 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003818 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003819 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003820 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003821 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003822 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003823 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3824 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003825 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003826 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3827 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
3828 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
3829 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
3830 skip |=
3831 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3832 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
3833 skip |=
3834 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3835 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003836 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003837 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3838 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003839 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003840 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003841 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003842 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3843 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003844 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003845 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003846 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003847 }
Dave Houlton48989f32017-05-26 15:01:46 -06003848 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3849 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003850 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003851 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003852 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003853 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003854
3855 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003856 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003857 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
3858 skip |=
3859 LogError(cb_node->commandBuffer, vuid,
3860 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003861 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003862
Dave Houlton48989f32017-05-26 15:01:46 -06003863 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003864 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
3865 skip |=
3866 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003867 }
Dave Houlton48989f32017-05-26 15:01:46 -06003868
Dave Houlton33c2d252017-06-09 17:08:32 -06003869 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003870 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
3871 skip |= LogError(cb_node->commandBuffer, vuid,
3872 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003873 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003874 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003875 }
3876
3877 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003878 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
3879 skip |= LogError(cb_node->commandBuffer, vuid,
3880 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3881 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003882 }
3883
Dave Houlton48989f32017-05-26 15:01:46 -06003884 // Validate source image offsets
3885 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003886 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003887 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003888 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
3889 skip |= LogError(cb_node->commandBuffer, vuid,
3890 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3891 "of (%1d, %1d). These must be (0, 1).",
3892 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003893 }
3894 }
3895
Dave Houlton33c2d252017-06-09 17:08:32 -06003896 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003897 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003898 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
3899 skip |= LogError(cb_node->commandBuffer, vuid,
3900 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3901 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3902 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003903 }
3904 }
3905
Dave Houlton33c2d252017-06-09 17:08:32 -06003906 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003907 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3908 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003909 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003910 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
3911 skip |= LogError(cb_node->commandBuffer, vuid,
3912 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
3913 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003914 }
3915 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3916 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003917 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003918 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
3919 skip |= LogError(cb_node->commandBuffer, vuid,
3920 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
3921 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003922 }
3923 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3924 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003925 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003926 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
3927 skip |= LogError(cb_node->commandBuffer, vuid,
3928 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
3929 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003930 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003931 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003932 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
3933 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
3934 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003935 }
Dave Houlton48989f32017-05-26 15:01:46 -06003936
3937 // Validate dest image offsets
3938 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003939 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003940 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003941 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
3942 skip |= LogError(cb_node->commandBuffer, vuid,
3943 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3944 "(%1d, %1d). These must be (0, 1).",
3945 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003946 }
3947 }
3948
Dave Houlton33c2d252017-06-09 17:08:32 -06003949 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003950 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003951 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
3952 skip |= LogError(cb_node->commandBuffer, vuid,
3953 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003954 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04003955 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003956 }
3957 }
3958
Dave Houlton33c2d252017-06-09 17:08:32 -06003959 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003960 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3961 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003962 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003963 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
3964 skip |= LogError(cb_node->commandBuffer, vuid,
3965 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
3966 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003967 }
3968 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3969 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003970 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003971 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
3972 skip |= LogError(cb_node->commandBuffer, vuid,
3973 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
3974 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003975 }
3976 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3977 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003978 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003979 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
3980 skip |= LogError(cb_node->commandBuffer, vuid,
3981 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
3982 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003983 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003984 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003985 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
3986 skip |= LogError(cb_node->commandBuffer, vuid,
3987 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003988 }
3989
Dave Houlton33c2d252017-06-09 17:08:32 -06003990 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3991 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3992 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003993 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
3994 skip |= LogError(cb_node->commandBuffer, vuid,
3995 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3996 "layerCount other than 1.",
3997 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003998 }
3999 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004000 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004001 } else {
4002 assert(0);
4003 }
4004 return skip;
4005}
4006
Jeff Leger178b1e52020-10-05 12:22:23 -04004007bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4008 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4009 const VkImageBlit *pRegions, VkFilter filter) const {
4010 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4011 COPY_COMMAND_VERSION_1);
4012}
4013
4014bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4015 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4016 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4017 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4018}
4019
4020template <typename RegionType>
4021void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4022 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4023 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004024 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004025 auto src_image_state = GetImageState(srcImage);
4026 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004027
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004028 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004029 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004030 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4031 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004032 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004033}
4034
Jeff Leger178b1e52020-10-05 12:22:23 -04004035void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4036 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4037 const VkImageBlit *pRegions, VkFilter filter) {
4038 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4039 pRegions, filter);
4040 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4041}
4042
4043void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4044 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4045 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4046 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4047 pBlitImageInfo->filter);
4048}
4049
John Zulauf2076e812020-01-08 14:55:54 -07004050GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
4051 assert(map);
4052 // This approach allows for a single hash lookup or/create new
4053 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
4054 if (inserted.second) {
4055 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06004056 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004057 inserted.first->second.reset(layout_map);
4058 return layout_map;
4059 } else {
4060 assert(nullptr != inserted.first->second.get());
4061 return inserted.first->second.get();
4062 }
4063 return nullptr;
4064}
4065
4066const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4067 auto it = map.find(image);
4068 if (it != map.end()) {
4069 return it->second.get();
4070 }
4071 return nullptr;
4072}
4073
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004074// 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 -07004075bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
4076 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004077 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004078 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07004079 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06004080 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004081 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004082 for (const auto &layout_map_entry : pCB->image_layout_map) {
4083 const auto image = layout_map_entry.first;
4084 const auto *image_state = GetImageState(image);
4085 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004086 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07004087 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004088 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07004089 if (initial_layout_map.empty()) continue;
4090
4091 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
4092 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4093 if (global_map == nullptr) {
4094 global_map = &empty_map;
4095 }
4096
4097 // Note: don't know if it would matter
4098 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4099
4100 auto pos = initial_layout_map.begin();
4101 const auto end = initial_layout_map.end();
4102 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
4103 pos->first.begin);
4104 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07004105 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07004106 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07004107 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 -07004108 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004109 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004110 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004111 image_layout = current_layout->pos_B->lower_bound->second;
4112 }
4113 const auto intersected_range = pos->first & current_layout->range;
4114 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4115 // TODO: Set memory invalid which is in mem_tracker currently
4116 } else if (image_layout != initial_layout) {
4117 // Need to look up the inital layout *state* to get a bit more information
4118 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4119 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4120 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4121 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004122 // We can report all the errors for the intersected range directly
4123 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004124 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004125 skip |= LogError(
4126 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004127 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004128 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004129 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004130 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004131 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004132 }
4133 }
John Zulauf2076e812020-01-08 14:55:54 -07004134 if (pos->first.includes(intersected_range.end)) {
4135 current_layout.seek(intersected_range.end);
4136 } else {
4137 ++pos;
4138 if (pos != end) {
4139 current_layout.seek(pos->first.begin);
4140 }
4141 }
John Zulauff660ad62019-03-23 07:16:05 -06004142 }
4143
locke-lunargf155ccf2020-02-18 11:34:15 -07004144 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07004145 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004146 }
John Zulauff660ad62019-03-23 07:16:05 -06004147
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004148 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004149}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004150
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004151void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004152 for (const auto &layout_map_entry : pCB->image_layout_map) {
4153 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004154 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004155 const auto *image_state = GetImageState(image);
4156 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07004157 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
4158 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07004159 }
4160}
4161
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004162// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004163// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4164// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004165bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4166 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06004167 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004168 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004169 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4170
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004171 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004172 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4173 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004174 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004175 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4176 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4177 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004178 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004179 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004180 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004181 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4182 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4183 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004184 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004185 string_VkImageLayout(first_layout));
4186 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4187 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004188 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004189 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004190 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004191 }
4192 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004193
4194 // Same as above for loadOp, but for stencilLoadOp
4195 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4196 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4197 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4198 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4199 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004200 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004201 string_VkImageLayout(first_layout));
4202 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4203 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4204 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004205 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004206 string_VkImageLayout(first_layout));
4207 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4208 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4209 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004210 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004211 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004212 }
4213 }
4214
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004215 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004216}
4217
Mark Lobodzinski96210742017-02-09 10:33:46 -07004218// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4219// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004220template <typename T1>
4221bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4222 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4223 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004224 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004225 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004226 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004227 if (strict) {
4228 correct_usage = ((actual & desired) == desired);
4229 } else {
4230 correct_usage = ((actual & desired) != 0);
4231 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004232
Mark Lobodzinski96210742017-02-09 10:33:46 -07004233 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004234 // All callers should have a valid VUID
4235 assert(msgCode != kVUIDUndefined);
4236 skip =
4237 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4238 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004239 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004240 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004241}
4242
4243// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4244// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004245bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004246 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004247 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004248 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004249}
4250
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004251bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004252 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004253 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004254 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4255 if ((image_format_features & desired) != desired) {
4256 // Same error, but more details if it was an AHB external format
4257 if (image_state->has_ahb_format == true) {
4258 skip |= LogError(image_state->image, vuid,
4259 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4260 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4261 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004262 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004263 } else {
4264 skip |= LogError(image_state->image, vuid,
4265 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4266 "with tiling %s.",
4267 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4268 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4269 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004270 }
4271 }
4272 return skip;
4273}
4274
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004275bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004276 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004277 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004278 // layerCount must not be zero
4279 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004280 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4281 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004282 }
4283 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4284 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004285 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4286 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004287 }
4288 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4289 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4290 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004291 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4292 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4293 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4294 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004295 }
4296 return skip;
4297}
4298
Mark Lobodzinski96210742017-02-09 10:33:46 -07004299// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4300// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004301bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004302 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004303 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004304 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004305}
4306
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004307bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004308 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004309 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004310
4311 const VkDeviceSize &range = pCreateInfo->range;
4312 if (range != VK_WHOLE_SIZE) {
4313 // Range must be greater than 0
4314 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004315 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004316 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004317 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4318 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004319 }
4320 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004321 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4322 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004323 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004324 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004325 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4326 "(%" PRIu32 ").",
4327 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004328 }
4329 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004330 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004331 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004332 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004333 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4334 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4335 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004336 }
4337 // The sum of range and offset must be less than or equal to the size of buffer
4338 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004339 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004340 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004341 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4342 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4343 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004344 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004345 } else {
4346 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4347
4348 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4349 // VkPhysicalDeviceLimits::maxTexelBufferElements
4350 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4351 device_limits->maxTexelBufferElements) {
4352 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4353 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4354 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4355 "), divided by the element size of the format (%" PRIu32
4356 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4357 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4358 device_limits->maxTexelBufferElements);
4359 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004360 }
4361 return skip;
4362}
4363
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004364bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004365 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004366 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004367 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4368 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004369 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004370 "vkCreateBufferView(): If buffer was created with `usage` containing "
4371 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004372 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004373 }
4374 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4375 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004376 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004377 "vkCreateBufferView(): If buffer was created with `usage` containing "
4378 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004379 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004380 }
4381 return skip;
4382}
4383
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004384bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004385 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004386 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004387
Dave Houltond8ed0212018-05-16 17:18:24 -06004388 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004389
Jeff Bolz87697532019-01-11 22:54:00 -06004390 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4391 if (chained_devaddr_struct) {
4392 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4393 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004394 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4395 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4396 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004397 }
4398 }
4399
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004400 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4401 if (chained_opaqueaddr_struct) {
4402 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4403 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004404 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4405 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4406 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004407 }
4408 }
4409
Shannon McPherson4984e642019-12-05 13:04:34 -07004410 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004411 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4412 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004413 skip |= LogError(
4414 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004415 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4416 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4417 }
4418
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004419 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004420 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4421 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4422 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004423 }
4424
sfricke-samsungedce77a2020-07-03 22:35:13 -07004425 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4426 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4427 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4428 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4429 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4430 }
4431 const VkBufferCreateFlags invalid_flags =
4432 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4433 if ((pCreateInfo->flags & invalid_flags) != 0) {
4434 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4435 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4436 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4437 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4438 }
4439 }
4440
Mark Lobodzinski96210742017-02-09 10:33:46 -07004441 return skip;
4442}
4443
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004444bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004445 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004446 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004447 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004448 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4449 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004450 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004451 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4452 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004453 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004454 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4455 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4456 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004457
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004458 // Buffer view offset must be less than the size of buffer
4459 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004460 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004461 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004462 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4463 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004464 }
4465
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004466 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004467 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4468 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4469 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004470 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4471 : "VUID-VkBufferViewCreateInfo-offset-00926";
4472 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004473 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004474 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4475 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004476 }
4477
4478 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4479 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4480 if ((elementSize % 3) == 0) {
4481 elementSize /= 3;
4482 }
4483 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4484 VkDeviceSize alignmentRequirement =
4485 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4486 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4487 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4488 }
4489 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004490 skip |= LogError(
4491 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004492 "vkCreateBufferView(): If buffer was created with usage containing "
4493 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004494 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4495 ") must be a multiple of the lesser of "
4496 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4497 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4498 "(%" PRId32
4499 ") is VK_TRUE, the size of a texel of the requested format. "
4500 "If the size of a texel is a multiple of three bytes, then the size of a "
4501 "single component of format is used instead",
4502 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4503 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4504 }
4505 }
4506 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4507 VkDeviceSize alignmentRequirement =
4508 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4509 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4510 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4511 }
4512 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004513 skip |= LogError(
4514 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004515 "vkCreateBufferView(): If buffer was created with usage containing "
4516 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004517 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4518 ") must be a multiple of the lesser of "
4519 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4520 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4521 "(%" PRId32
4522 ") is VK_TRUE, the size of a texel of the requested format. "
4523 "If the size of a texel is a multiple of three bytes, then the size of a "
4524 "single component of format is used instead",
4525 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4526 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4527 }
4528 }
4529 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004530
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004531 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004532
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004533 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004534 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004535 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004536}
4537
Mark Lobodzinski602de982017-02-09 11:01:33 -07004538// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004539bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004540 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004541 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004542 const IMAGE_STATE *image_state = GetImageState(image);
4543 // checks color format and (single-plane or non-disjoint)
4544 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004545 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004546 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004547 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 -07004548 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004549 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 -07004550 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004551 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004552 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004553 skip |= LogError(image, vuid,
4554 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4555 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4556 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004557 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004558 skip |= LogError(image, vuid,
4559 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4560 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4561 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004562 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004563 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004564 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004565 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 -07004566 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004567 skip |=
4568 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 -07004569 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004570 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004571 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004572 skip |=
4573 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 -07004574 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004575 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4576 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004577 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004578 } else if (FormatIsMultiplane(format)) {
4579 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4580 if (3 == FormatPlaneCount(format)) {
4581 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4582 }
4583 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004584 skip |=
4585 LogError(image, vuid,
4586 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4587 "set, where n = [0, 1, 2].",
4588 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004589 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004590 }
4591 return skip;
4592}
4593
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004594bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4595 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004596 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4597 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004598 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004599
4600 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004601 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004602 skip |= LogError(image, errorCodes.base_mip_err,
4603 "%s: %s.baseMipLevel (= %" PRIu32
4604 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4605 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004606 }
Petr Kraus4d718682017-05-18 03:38:41 +02004607
Petr Krausffa94af2017-08-08 21:46:02 +02004608 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4609 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004610 skip |=
4611 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004612 } else {
4613 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004614
Petr Krausffa94af2017-08-08 21:46:02 +02004615 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004616 skip |= LogError(image, errorCodes.mip_count_err,
4617 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4618 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4619 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4620 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004621 }
Petr Kraus4d718682017-05-18 03:38:41 +02004622 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004623 }
Petr Kraus4d718682017-05-18 03:38:41 +02004624
4625 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004626 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004627 skip |= LogError(image, errorCodes.base_layer_err,
4628 "%s: %s.baseArrayLayer (= %" PRIu32
4629 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4630 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004631 }
Petr Kraus4d718682017-05-18 03:38:41 +02004632
Petr Krausffa94af2017-08-08 21:46:02 +02004633 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4634 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004635 skip |=
4636 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004637 } else {
4638 const uint64_t necessary_layer_count =
4639 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004640
Petr Krausffa94af2017-08-08 21:46:02 +02004641 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004642 skip |= LogError(image, errorCodes.layer_count_err,
4643 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4644 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4645 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4646 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004647 }
Petr Kraus4d718682017-05-18 03:38:41 +02004648 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004649 }
Petr Kraus4d718682017-05-18 03:38:41 +02004650
Mark Lobodzinski602de982017-02-09 11:01:33 -07004651 return skip;
4652}
4653
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004654bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004655 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004656 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004657 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4658 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4659 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4660
4661 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4662 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4663
4664 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004665 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4666 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004667 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004668 : "VUID-VkImageViewCreateInfo-image-01482")
4669 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4670 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004671 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004672 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4673 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004674
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004675 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004676 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004677 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004678}
4679
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004680bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004681 const VkImageSubresourceRange &subresourceRange,
4682 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004683 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004684 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4685 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4686 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4687 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004688
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004689 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004690 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004691 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004692}
4693
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004694bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004695 const VkImageSubresourceRange &subresourceRange,
4696 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004697 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004698 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4699 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4700 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4701 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004702
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004703 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004704 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4705 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004706}
4707
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004708bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004709 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004710 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004711 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004712 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4713 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4714 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4715 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004716
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004717 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004718 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004719}
4720
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004721bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4722 const VkImageUsageFlags image_usage) const {
4723 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4724 bool skip = false;
4725
4726 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4727 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4728
4729 if (image_state->has_ahb_format == true) {
4730 // AHB image view and image share same feature sets
4731 tiling_features = image_state->format_features;
4732 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4733 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4734 assert(device_extensions.vk_ext_image_drm_format_modifier);
4735 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4736 nullptr};
4737 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4738
4739 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4740 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4741 nullptr};
4742 format_properties_2.pNext = (void *)&drm_properties_list;
4743 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4744
4745 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4746 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4747 0) {
4748 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4749 }
4750 }
4751 } else {
4752 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4753 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4754 : format_properties.optimalTilingFeatures;
4755 }
4756
4757 if (tiling_features == 0) {
4758 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4759 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4760 "physical device.",
4761 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4762 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4763 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4764 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4765 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4766 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4767 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4768 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4769 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4770 "VK_IMAGE_USAGE_STORAGE_BIT.",
4771 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4772 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4773 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4774 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4775 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4776 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4777 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4778 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4779 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4780 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4781 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4782 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4783 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4784 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4785 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4786 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4787 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4788 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4789 }
4790
4791 return skip;
4792}
4793
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004794bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004795 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004796 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004797 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004798 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004799 skip |=
4800 ValidateImageUsageFlags(image_state,
4801 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4802 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07004803 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
4804 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4805 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004806 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07004807 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004808 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004809 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004810 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004811 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004812 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004813 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004814
4815 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4816 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004817 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004818 VkFormat view_format = pCreateInfo->format;
4819 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004820 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004821 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004822
Dave Houltonbd2e2622018-04-10 16:41:14 -06004823 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004824 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004825 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004826 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004827 if (!device_extensions.vk_ext_separate_stencil_usage) {
4828 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004829 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4830 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4831 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004832 }
4833 } else {
4834 const auto image_stencil_struct =
4835 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4836 if (image_stencil_struct == nullptr) {
4837 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004838 skip |= LogError(
4839 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004840 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4841 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4842 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4843 }
4844 } else {
4845 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4846 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4847 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004848 skip |= LogError(
4849 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004850 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4851 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4852 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4853 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4854 }
4855 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4856 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004857 skip |= LogError(
4858 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004859 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4860 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4861 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4862 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4863 }
4864 }
4865 }
4866 }
4867
Dave Houltonbd2e2622018-04-10 16:41:14 -06004868 image_usage = chained_ivuci_struct->usage;
4869 }
4870
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004871 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4872 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004873 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004874 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004875 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004876 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004877 std::stringstream ss;
4878 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004879 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004880 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004881 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004882 }
4883 } else {
Nathaniel Cesario0046c312020-10-07 23:28:28 -06004884 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004885 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4886 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004887 const char *error_vuid;
4888 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4889 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4890 } else if ((device_extensions.vk_khr_maintenance2) &&
4891 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4892 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4893 } else if ((!device_extensions.vk_khr_maintenance2) &&
4894 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4895 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4896 } else {
4897 // both enabled
4898 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4899 }
Dave Houltonc7988072018-04-16 11:46:56 -06004900 std::stringstream ss;
4901 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004902 << " is not in the same format compatibility class as "
4903 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004904 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4905 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004906 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004907 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004908 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004909 }
4910 } else {
4911 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004912 // Unless it is a multi-planar color bit aspect
4913 if ((image_format != view_format) &&
4914 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4915 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4916 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004917 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004918 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004919 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004920 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004921 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004922 }
4923 }
4924
4925 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004926 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004927
4928 switch (image_type) {
4929 case VK_IMAGE_TYPE_1D:
4930 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004931 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4932 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4933 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004934 }
4935 break;
4936 case VK_IMAGE_TYPE_2D:
4937 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4938 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4939 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004940 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4941 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4942 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004943 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004944 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4945 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4946 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004947 }
4948 }
4949 break;
4950 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004951 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004952 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4953 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4954 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004955 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004956 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4957 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4958 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004959 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4960 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004961 skip |= LogError(
4962 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4963 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4964 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4965 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4966 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004967 }
4968 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004969 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4970 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4971 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004972 }
4973 }
4974 } else {
4975 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004976 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4977 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4978 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004979 }
4980 }
4981 break;
4982 default:
4983 break;
4984 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004985
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004986 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004987 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004988 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004989 }
4990
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004991 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004992
Jeff Bolz9af91c52018-09-01 21:53:57 -05004993 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4994 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004995 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
4996 "vkCreateImageView() If image was created with usage containing "
4997 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4998 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05004999 }
5000 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005001 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5002 "vkCreateImageView() If image was created with usage containing "
5003 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005004 }
5005 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005006
5007 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5008 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5009 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5010 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5011 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5012 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5013 }
5014 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5015 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5016 skip |= LogError(
5017 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5018 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5019 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5020 }
5021 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005022
5023 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5024 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005025 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005026 "vkCreateImageView(): If image was created with usage containing "
5027 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5028 pCreateInfo->subresourceRange.levelCount);
5029 }
5030 }
5031 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5032 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005033 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005034 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5035 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5036 }
5037 } else {
5038 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5039 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5040 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005041 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005042 "vkCreateImageView(): If image was created with usage containing "
5043 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5044 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5045 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5046 }
5047 }
5048 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005049
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005050 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5051 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5052 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5053 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5054 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5055 }
5056 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5057 skip |=
5058 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5059 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5060 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5061 }
5062 }
5063 if (device_extensions.vk_ext_fragment_density_map_2) {
5064 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5065 (pCreateInfo->subresourceRange.layerCount >
5066 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5067 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5068 "vkCreateImageView(): If image was created with flags containing "
5069 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5070 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5071 pCreateInfo->subresourceRange.layerCount,
5072 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5073 }
5074 }
5075
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005076 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
5077 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5078 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5079 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5080 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5081 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5082 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5083 }
5084 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005085 }
5086 return skip;
5087}
5088
Jeff Leger178b1e52020-10-05 12:22:23 -04005089template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005090bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005091 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005092 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005093 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5094 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5095 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005096
5097 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5098 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5099 VkDeviceSize src_min = UINT64_MAX;
5100 VkDeviceSize src_max = 0;
5101 VkDeviceSize dst_min = UINT64_MAX;
5102 VkDeviceSize dst_max = 0;
5103
5104 for (uint32_t i = 0; i < regionCount; i++) {
5105 src_min = std::min(src_min, pRegions[i].srcOffset);
5106 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5107 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5108 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5109
5110 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5111 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005112 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
5113 skip |= LogError(src_buffer_state->buffer, vuid,
5114 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5115 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005116 }
5117
5118 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5119 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005120 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
5121 skip |= LogError(dst_buffer_state->buffer, vuid,
5122 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5123 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005124 }
5125
5126 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5127 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005128 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
5129 skip |= LogError(src_buffer_state->buffer, vuid,
5130 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005131 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005132 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005133 }
5134
5135 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5136 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005137 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
5138 skip |= LogError(dst_buffer_state->buffer, vuid,
5139 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005140 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005141 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005142 }
5143 }
5144
5145 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5146 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5147 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005148 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
5149 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
5150 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005151 }
5152 }
5153
5154 return skip;
5155}
5156
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005157bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005158 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005159 const auto cb_node = GetCBState(commandBuffer);
5160 const auto src_buffer_state = GetBufferState(srcBuffer);
5161 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005162
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005163 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005164 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5165 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005166 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005167 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005168 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5169 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005170 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005171 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5172 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005173 skip |=
5174 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5175 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005176 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5177 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Jeff Leger178b1e52020-10-05 12:22:23 -04005178 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07005179 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5180 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5181 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005182 return skip;
5183}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005184
Jeff Leger178b1e52020-10-05 12:22:23 -04005185bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
5186 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
5187 const auto cb_node = GetCBState(commandBuffer);
5188 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
5189 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
5190
5191 bool skip = false;
5192 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
5193 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
5194 // Validate that SRC & DST buffers have correct usage flags set
5195 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
5196 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
5197 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5198 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
5199 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
5200 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
5201 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer2KHR()",
5202 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5203 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-cmdpool");
5204 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
5205 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-renderpass");
5206 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
5207 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
5208 skip |=
5209 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
5210 skip |=
5211 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
5212 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
5213 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
5214 return skip;
5215}
5216
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005217bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005218 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005219 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005220 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005221 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005222 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5223 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005224 }
5225 }
5226 return skip;
5227}
5228
Jeff Bolz5c801d12019-10-09 10:38:45 -05005229bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5230 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005231 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005232 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005233
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005234 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005235 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005236 skip |=
5237 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005238 }
5239 return skip;
5240}
5241
Jeff Bolz5c801d12019-10-09 10:38:45 -05005242bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005243 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005244
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005245 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005246 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005247 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005248 }
5249 return skip;
5250}
5251
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005252bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005253 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005254 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005255 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005256 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005257 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005258 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005259 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005260 }
5261 return skip;
5262}
5263
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005264bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005265 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005266 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005267 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005268 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005269 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005270 skip |=
5271 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5272 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005273 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005274 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005275 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5276 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005277 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005278
sfricke-samsung022fa252020-07-24 03:26:16 -07005279 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5280 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5281
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005282 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005283 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5284 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5285 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5286 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005287 }
5288
5289 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005290 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5291 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5292 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5293 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005294 }
5295
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005296 return skip;
5297}
5298
Jeff Leger178b1e52020-10-05 12:22:23 -04005299template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07005300bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005301 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
5302 const char *function, CopyCommandVersion version) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005303 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005304 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5305 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04005306
sfricke-samsung125d2b42020-05-28 06:32:43 -07005307 assert(image_state != nullptr);
5308 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005309
5310 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005311 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005312 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5313 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005314 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-srcImage-00199",
5315 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5316 "and 1, respectively.",
5317 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005318 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005319 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005320
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005321 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5322 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005323 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-srcImage-00201",
Jeff Leger178b1e52020-10-05 12:22:23 -04005324 "%s: pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005325 "must be 0 and 1, respectively.",
5326 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005327 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005328 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005329
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005330 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5331 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005332 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
Jeff Leger178b1e52020-10-05 12:22:23 -04005333 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005334 "For 3D images these must be 0 and 1, respectively.",
5335 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005336 }
5337 }
5338
5339 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005340 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005341 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005342
sfricke-samsung125d2b42020-05-28 06:32:43 -07005343 // If not depth/stencil and not multi-plane
5344 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5345 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005346 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-bufferOffset-01558"
5347 : "VUID-vkCmdCopyBufferToImage-bufferOffset-00193";
sfricke-samsung125d2b42020-05-28 06:32:43 -07005348 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005349 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005350 " must be a multiple of this format's texel size (%" PRIu32 ").",
5351 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005352 }
5353
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005354 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5355 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005356 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005357 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
Jeff Leger178b1e52020-10-05 12:22:23 -04005358 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005359 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005360 }
5361
5362 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5363 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005364 skip |=
5365 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
5366 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5367 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005368 }
5369
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005370 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005371 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005372 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005373 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 -06005374 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5375 static_cast<int32_t>(adjusted_image_extent.width))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005376 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00197",
Jeff Leger178b1e52020-10-05 12:22:23 -04005377 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005378 "zero or <= image subresource width (%d).",
5379 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005380 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005381 }
5382
5383 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005384 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 -06005385 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5386 static_cast<int32_t>(adjusted_image_extent.height))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005387 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00198",
Jeff Leger178b1e52020-10-05 12:22:23 -04005388 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005389 "zero or <= image subresource height (%d).",
5390 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005391 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005392 }
5393
5394 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005395 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 -06005396 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5397 static_cast<int32_t>(adjusted_image_extent.depth))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005398 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
Jeff Leger178b1e52020-10-05 12:22:23 -04005399 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005400 "zero or <= image subresource depth (%d).",
5401 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005402 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005403 }
5404
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005405 // subresource aspectMask must have exactly 1 bit set
5406 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005407 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005408 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005409 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
5410 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005411 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005412 }
5413
5414 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005415 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005416 skip |=
5417 LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
5418 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5419 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005420 }
5421
5422 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005423 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5424 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005425
5426 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005427 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005428 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203"
5429 : "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203";
Jeff Leger178b1e52020-10-05 12:22:23 -04005430 skip |=
5431 LogError(image_state->image, vuid,
5432 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5433 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005434 }
5435
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005436 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005437 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005438 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204"
5439 : "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005440 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005441 image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005442 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005443 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005444 }
5445
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005446 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005447 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5448 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5449 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005450 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-imageOffset-00205"
5451 : "VUID-vkCmdCopyBufferToImage-imageOffset-00205";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005452 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005453 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005454 "width & height (%d, %d)..",
5455 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5456 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005457 }
5458
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005459 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005460 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005461 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005462 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-bufferOffset-00206"
5463 : "VUID-vkCmdCopyBufferToImage-bufferOffset-00206";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005464 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005465 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005466 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5467 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005468 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005469
5470 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005471 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005472 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005473 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005474 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-imageExtent-00207"
5475 : "VUID-vkCmdCopyBufferToImage-imageExtent-00207";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005476 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005477 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005478 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5479 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5480 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005481 }
5482
5483 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005484 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005485 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005486 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-imageExtent-00208"
5487 : "VUID-vkCmdCopyBufferToImage-imageExtent-00208";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005488 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005489 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005490 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5491 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5492 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005493 }
5494
5495 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005496 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005497 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005498 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-imageExtent-00209"
5499 : "VUID-vkCmdCopyBufferToImage-imageExtent-00209";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005500 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005501 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005502 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5503 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5504 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005505 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005506 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005507
5508 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005509 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005510 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005511 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005512 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
Jeff Leger178b1e52020-10-05 12:22:23 -04005513 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005514 "format has three planes.",
5515 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005516 }
5517
5518 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005519 if (0 ==
5520 (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 -06005521 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
Jeff Leger178b1e52020-10-05 12:22:23 -04005522 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005523 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5524 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005525 } else {
5526 // Know aspect mask is valid
5527 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5528 const uint32_t compatible_size = FormatElementSize(compatible_format);
5529 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5530 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005531 image_state->image, "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
Jeff Leger178b1e52020-10-05 12:22:23 -04005532 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07005533 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5534 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5535 string_VkFormat(compatible_format));
5536 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005537 }
5538 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005539 }
5540
5541 return skip;
5542}
5543
Jeff Leger178b1e52020-10-05 12:22:23 -04005544template <typename BufferImageCopyRegionType>
5545bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
5546 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005547 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005548 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005549
5550 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005551 VkExtent3D extent = pRegions[i].imageExtent;
5552 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005553
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005554 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5555 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005556 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5557 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5558 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005559 }
5560
5561 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5562
5563 // 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 -06005564 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005565 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005566 if (image_extent.width % block_extent.width) {
5567 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5568 }
5569 if (image_extent.height % block_extent.height) {
5570 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5571 }
5572 if (image_extent.depth % block_extent.depth) {
5573 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5574 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005575 }
5576
Dave Houltonfc1a4052017-04-27 14:32:45 -06005577 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005578 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005579 }
5580 }
5581
5582 return skip;
5583}
5584
Jeff Leger178b1e52020-10-05 12:22:23 -04005585template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005586bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005587 const BufferImageCopyRegionType *pRegions, const char *func_name,
5588 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005589 bool skip = false;
5590
5591 VkDeviceSize buffer_size = buff_state->createInfo.size;
5592
5593 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005594 VkDeviceSize max_buffer_offset =
5595 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5596 if (buffer_size < max_buffer_offset) {
5597 skip |=
5598 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 -07005599 }
5600 }
5601
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005602 return skip;
5603}
5604
Jeff Leger178b1e52020-10-05 12:22:23 -04005605template <typename BufferImageCopyRegionType>
5606bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5607 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
5608 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005609 const auto cb_node = GetCBState(commandBuffer);
5610 const auto src_image_state = GetImageState(srcImage);
5611 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005612
Jeff Leger178b1e52020-10-05 12:22:23 -04005613 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5614 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
5615 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
5616 const char *vuid;
5617
5618 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005619
5620 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005621 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005622
5623 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005624 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005625
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005626 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005627
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005628 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005629 vuid =
5630 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
5631 skip |= LogError(cb_node->createInfo.commandPool, vuid,
5632 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
5633 "or transfer capabilities.",
5634 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005635 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005636 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
5637 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
5638 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
5639 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005640
Jeff Leger178b1e52020-10-05 12:22:23 -04005641 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
5642 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
5643 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5644
5645 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
5646 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
5647 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
5648 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005649
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005650 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04005651 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
5652 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005653 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005654 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
5655 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005656 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005657 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
5658 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
5659 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
5660 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
5661 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
5662 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005663
5664 // Validation for VK_EXT_fragment_density_map
5665 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005666 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
5667 skip |= LogError(cb_node->commandBuffer, vuid,
5668 "%s: srcImage must not have been created with flags containing "
5669 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5670 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005671 }
5672
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005673 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005674 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
5675 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005676 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005677 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer-renderpass" : "VUID-vkCmdCopyImageToBuffer-renderpass";
5678 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005679 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005680
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005681 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Jeff Leger178b1e52020-10-05 12:22:23 -04005682 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
5683 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
5684 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
5685 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
5686
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005687 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005688 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5689 vuid =
5690 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005691 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005692 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
5693 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
5694 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
5695 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
5696 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
5697 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5698 "imageSubresource", vuid);
5699 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
5700 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005701 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005702 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005703 }
5704 return skip;
5705}
5706
Jeff Leger178b1e52020-10-05 12:22:23 -04005707bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5708 VkBuffer dstBuffer, uint32_t regionCount,
5709 const VkBufferImageCopy *pRegions) const {
5710 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
5711 COPY_COMMAND_VERSION_1);
5712}
5713
5714bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5715 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
5716 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
5717 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
5718 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
5719}
5720
John Zulauf1686f232019-07-09 16:27:11 -06005721void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5722 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5723 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5724
5725 auto cb_node = GetCBState(commandBuffer);
5726 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005727 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005728 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005729 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005730 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005731}
5732
Jeff Leger178b1e52020-10-05 12:22:23 -04005733void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5734 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
5735 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
5736
5737 auto cb_node = GetCBState(commandBuffer);
5738 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
5739 // Make sure that all image slices record referenced layout
5740 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
5741 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
5742 pCopyImageToBufferInfo->srcImageLayout);
5743 }
5744}
5745
5746template <typename RegionType>
5747bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5748 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
5749 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005750 const auto cb_node = GetCBState(commandBuffer);
5751 const auto src_buffer_state = GetBufferState(srcBuffer);
5752 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005753
Jeff Leger178b1e52020-10-05 12:22:23 -04005754 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5755 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
5756 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
5757 const char *vuid;
5758
5759 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005760
5761 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005762 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005763
sfricke-samsungea4fd142020-10-17 23:51:59 -07005764 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool";
5765 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
5766
Jeff Leger178b1e52020-10-05 12:22:23 -04005767 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
5768 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
5769 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
5770 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
5771
5772 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
5773 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
5774 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5775 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
5776 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
5777 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
5778 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
5779 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
5780 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005781 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005782 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
5783 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005784 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005785 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
5786 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
5787 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
5788 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
5789 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
5790 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005791
5792 // Validation for VK_EXT_fragment_density_map
5793 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005794 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
5795 skip |= LogError(cb_node->commandBuffer, vuid,
5796 "%s: dstImage must not have been created with flags containing "
5797 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5798 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005799 }
5800
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005801 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005802 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
5803 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005804 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005805 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-renderpass" : "VUID-vkCmdCopyBufferToImage-renderpass";
5806 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005807 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005808
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005809 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Jeff Leger178b1e52020-10-05 12:22:23 -04005810 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
5811 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
5812 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
5813 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
5814
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005815 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005816 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5817 vuid =
5818 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005819 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005820 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
5821 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
5822 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
5823 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
5824 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
5825 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5826 "imageSubresource", vuid);
5827 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
5828 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005829 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005830 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07005831
5832 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
5833 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
5834 assert(command_pool != nullptr);
5835 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
5836 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
5837 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
5838 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
5839 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
5840 LogObjectList objlist(cb_node->commandBuffer);
5841 objlist.add(command_pool->commandPool);
5842 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
5843 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
5844 skip |= LogError(dst_image_state->image, vuid,
5845 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
5846 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
5847 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
5848 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
5849 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
5850 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005851 }
5852 return skip;
5853}
5854
Jeff Leger178b1e52020-10-05 12:22:23 -04005855bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5856 VkImageLayout dstImageLayout, uint32_t regionCount,
5857 const VkBufferImageCopy *pRegions) const {
5858 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
5859 COPY_COMMAND_VERSION_1);
5860}
5861
5862bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
5863 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
5864 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
5865 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
5866 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
5867}
5868
John Zulauf1686f232019-07-09 16:27:11 -06005869void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5870 VkImageLayout dstImageLayout, uint32_t regionCount,
5871 const VkBufferImageCopy *pRegions) {
5872 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5873
5874 auto cb_node = GetCBState(commandBuffer);
5875 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005876 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005877 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005878 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005879 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005880}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005881
Jeff Leger178b1e52020-10-05 12:22:23 -04005882void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
5883 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
5884 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
5885
5886 auto cb_node = GetCBState(commandBuffer);
5887 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
5888 // Make sure that all image slices are record referenced layout
5889 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
5890 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
5891 pCopyBufferToImageInfo2KHR->dstImageLayout);
5892 }
5893}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005894bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005895 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005896 bool skip = false;
5897 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5898
Dave Houlton1d960ff2018-01-19 12:17:05 -07005899 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005900 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5901 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5902 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005903 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5904 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005905 }
5906
John Zulaufa26d3c82019-08-14 16:09:08 -06005907 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005908 if (!image_entry) {
5909 return skip;
5910 }
5911
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005912 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5913 if (device_extensions.vk_ext_image_drm_format_modifier) {
5914 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5915 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005916 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5917 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5918 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005919 }
5920 } else {
5921 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005922 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5923 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005924 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005925 }
5926
Dave Houlton1d960ff2018-01-19 12:17:05 -07005927 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005928 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005929 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5930 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5931 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005932 }
5933
Dave Houlton1d960ff2018-01-19 12:17:05 -07005934 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005935 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005936 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5937 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5938 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005939 }
5940
Dave Houlton1d960ff2018-01-19 12:17:05 -07005941 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005942 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005943 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5944 if (FormatIsMultiplane(img_format)) {
5945 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5946 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5947 if (FormatPlaneCount(img_format) > 2u) {
5948 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5949 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5950 }
5951 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005952 skip |= LogError(image, vuid,
5953 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5954 ") must be a single-plane specifier flag.",
5955 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005956 }
5957 } else if (FormatIsColor(img_format)) {
5958 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005959 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5960 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5961 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005962 }
5963 } else if (FormatIsDepthOrStencil(img_format)) {
5964 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5965 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005966 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005967 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5968 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5969 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5970 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005971 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5972 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5973 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005974 }
5975 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005976
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005977 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005978 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005979 }
5980
Mike Weiblen672b58b2017-02-21 14:32:53 -07005981 return skip;
5982}
sfricke-samsung022fa252020-07-24 03:26:16 -07005983
5984// Validates the image is allowed to be protected
5985bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
5986 const char *vuid) const {
5987 bool skip = false;
5988 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
5989 LogObjectList objlist(cb_state->commandBuffer);
5990 objlist.add(image_state->image);
5991 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while image %s is a protected image", cmd_name,
5992 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
5993 report_data->FormatHandle(image_state->image).c_str());
5994 }
5995 return skip;
5996}
5997
5998// Validates the image is allowed to be unprotected
5999bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
6000 const char *vuid) const {
6001 bool skip = false;
6002 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6003 LogObjectList objlist(cb_state->commandBuffer);
6004 objlist.add(image_state->image);
6005 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while image %s is an unprotected image", cmd_name,
6006 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6007 report_data->FormatHandle(image_state->image).c_str());
6008 }
6009 return skip;
6010}
6011
6012// Validates the buffer is allowed to be protected
6013bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
6014 const char *vuid) const {
6015 bool skip = false;
6016 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6017 LogObjectList objlist(cb_state->commandBuffer);
6018 objlist.add(buffer_state->buffer);
6019 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while buffer %s is a protected buffer", cmd_name,
6020 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6021 report_data->FormatHandle(buffer_state->buffer).c_str());
6022 }
6023 return skip;
6024}
6025
6026// Validates the buffer is allowed to be unprotected
6027bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
6028 const char *vuid) const {
6029 bool skip = false;
6030 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6031 LogObjectList objlist(cb_state->commandBuffer);
6032 objlist.add(buffer_state->buffer);
6033 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while buffer %s is an unprotected buffer", cmd_name,
6034 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6035 report_data->FormatHandle(buffer_state->buffer).c_str());
6036 }
6037 return skip;
6038}