blob: 04ef6d214815ea395e5b59876b843c1c563ccc39 [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);
Tony Barbour55688172020-09-23 15:19:50 -0700635 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
636 // the next "constant value" range
637 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700638 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700639
John Zulauf5e617452019-11-19 14:44:16 -0700640 // Allow for differing depth and stencil layouts
641 VkImageLayout check_layout = attachment_initial_layout;
642 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
643
644 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700645 subres_skip |= LogError(
646 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700647 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
648 "and the %s layout of the attachment is %s. The layouts must match, or the render "
649 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700650 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100651 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700652 }
John Zulauf5e617452019-11-19 14:44:16 -0700653
Tobias Hectorc9057422019-07-23 12:15:52 +0100654 skip |= subres_skip;
655 }
656
657 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
658 framebuffer, render_pass, i, "initial layout");
659
660 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
661 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100662 }
663
Tobias Hectorc9057422019-07-23 12:15:52 +0100664 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
665 auto &subpass = pRenderPassInfo->pSubpasses[j];
666 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
667 auto &attachment_ref = subpass.pInputAttachments[k];
668 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
669 auto image_view = attachments[attachment_ref.attachment];
670 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100671
Tobias Hectorc9057422019-07-23 12:15:52 +0100672 if (view_state) {
673 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700674 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
675 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100676 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100677 }
678 }
679 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100680
Tobias Hectorc9057422019-07-23 12:15:52 +0100681 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
682 auto &attachment_ref = subpass.pColorAttachments[k];
683 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
684 auto image_view = attachments[attachment_ref.attachment];
685 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100686
Tobias Hectorc9057422019-07-23 12:15:52 +0100687 if (view_state) {
688 auto image = view_state->create_info.image;
689 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
690 framebuffer, render_pass, attachment_ref.attachment,
691 "color attachment layout");
692 if (subpass.pResolveAttachments) {
693 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
694 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
695 attachment_ref.attachment, "resolve attachment layout");
696 }
697 }
698 }
699 }
700
701 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
702 auto &attachment_ref = *subpass.pDepthStencilAttachment;
703 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
704 auto image_view = attachments[attachment_ref.attachment];
705 auto view_state = GetImageViewState(image_view);
706
707 if (view_state) {
708 auto image = view_state->create_info.image;
709 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
710 framebuffer, render_pass, attachment_ref.attachment,
711 "input attachment layout");
712 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100713 }
714 }
715 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700716 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600717 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700718}
719
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600720void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700721 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700722 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700723 IMAGE_VIEW_STATE *image_view = nullptr;
724 if (pFramebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
725 const auto attachment_info =
726 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pCB->activeRenderPassBeginInfo.pNext);
727 if (attachment_info) image_view = GetImageViewState(attachment_info->pAttachments[ref.attachment]);
728 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300729 image_view = GetAttachmentImageViewState(pCB, pFramebuffer, ref.attachment);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700730 }
John Zulauf8e308292018-09-21 11:34:37 -0600731 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700732 VkImageLayout stencil_layout = kInvalidLayout;
733 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
734 if (attachment_reference_stencil_layout) {
735 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
736 }
737
738 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600739 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700740 }
741}
742
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600743void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
744 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700745 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700746
747 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700748 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700749 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700750 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700751 }
752 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700753 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700754 }
755 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700756 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700757 }
758 }
759}
760
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700761// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
762// 1. Transition into initialLayout state
763// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600764void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700765 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700766 // First transition into initialLayout
767 auto const rpci = render_pass_state->createInfo.ptr();
768 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700769 IMAGE_VIEW_STATE *view_state = nullptr;
770 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
771 const auto attachment_info =
772 lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(cb_state->activeRenderPassBeginInfo.pNext);
773 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
774 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +0300775 view_state = GetAttachmentImageViewState(cb_state, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -0700776 }
John Zulauf8e308292018-09-21 11:34:37 -0600777 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700778 VkImageLayout stencil_layout = kInvalidLayout;
779 const auto *attachment_description_stencil_layout =
780 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
781 if (attachment_description_stencil_layout) {
782 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
783 }
784
785 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600786 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700787 }
788 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700789 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700790}
791
Dave Houlton10b39482017-03-16 13:18:15 -0600792bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600793 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600794 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600795 }
796 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600797 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600798 }
799 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600800 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600801 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700802 if (0 !=
803 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
804 if (FormatPlaneCount(format) == 1) return false;
805 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600806 return true;
807}
808
Mike Weiblen62d08a32017-03-07 22:18:27 -0700809// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200810bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
811 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600812 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700813 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200814 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600815 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700816
817 switch (layout) {
818 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
819 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600820 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700821 }
822 break;
823 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
824 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600825 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700826 }
827 break;
828 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
829 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600830 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700831 }
832 break;
833 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
834 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600835 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700836 }
837 break;
838 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
839 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600840 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700841 }
842 break;
843 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
844 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600845 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700846 }
847 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600848 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500849 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
850 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
851 }
852 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700853 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
854 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
855 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
856 }
857 break;
858 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
859 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
860 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
861 }
862 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700863 default:
864 // Other VkImageLayout values do not have VUs defined in this context.
865 break;
866 }
867
Dave Houlton8e9f6542018-05-18 12:18:22 -0600868 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700869 skip |= LogError(img_barrier.image, msg_code,
870 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
871 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
872 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700873 }
874 return skip;
875}
876
877// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600878bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
879 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700880 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700881
Petr Krausad0096a2019-08-09 18:35:04 +0200882 // Scoreboard for checking for duplicate and inconsistent barriers to images
883 struct ImageBarrierScoreboardEntry {
884 uint32_t index;
885 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
886 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
887 const VkImageMemoryBarrier *barrier;
888 };
889 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
890 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
891
John Zulauf463c51e2018-05-31 13:29:20 -0600892 // Scoreboard for duplicate layout transition barriers within the list
893 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
894 ImageBarrierScoreboardImageMap layout_transitions;
895
Mike Weiblen62d08a32017-03-07 22:18:27 -0700896 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200897 const auto &img_barrier = pImageMemoryBarriers[i];
898 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700899
John Zulauf463c51e2018-05-31 13:29:20 -0600900 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
901 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
902 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200903 if (img_barrier.oldLayout != img_barrier.newLayout) {
904 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
905 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600906 if (image_it != layout_transitions.end()) {
907 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200908 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600909 if (subres_it != subres_map.end()) {
910 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200911 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
912 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
913 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700914 skip = LogError(
915 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200916 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600917 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
918 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200919 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
920 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
921 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600922 }
923 entry = new_entry;
924 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200925 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600926 }
927 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200928 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600929 }
930 }
931
Petr Krausad0096a2019-08-09 18:35:04 +0200932 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600933 if (image_state) {
934 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200935 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
936 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600937
938 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
939 if (image_state->layout_locked) {
940 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700941 skip |= LogError(
942 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700943 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600944 " 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 -0700945 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200946 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600947 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600948
John Zulaufa4472282019-08-22 14:44:34 -0600949 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700950 const VkFormat image_format = image_create_info.format;
951 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600952 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700953 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700954 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600955 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
956 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700957 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
958 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
959 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
960 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700961 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600962 }
963 } else {
964 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
965 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -0700966 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
967 ? "VUID-VkImageMemoryBarrier-image-03320"
968 : "VUID-VkImageMemoryBarrier-image-01207";
969 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700970 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
971 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
972 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700973 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600974 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700975 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700976 }
John Zulauff660ad62019-03-23 07:16:05 -0600977
Petr Krausad0096a2019-08-09 18:35:04 +0200978 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
979 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600980 // TODO: Set memory invalid which is in mem_tracker currently
981 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
982 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -0600983 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -0600984 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600985 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200986 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -0700987 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
988 // the next "constant value" range
989 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700990 const auto &value = *pos;
991 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700992 subres_skip = LogError(
993 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700994 "%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 -0700995 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700996 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -0700997 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
998 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600999 }
John Zulauf5e617452019-11-19 14:44:16 -07001000 }
John Zulauff660ad62019-03-23 07:16:05 -06001001 skip |= subres_skip;
1002 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001003
1004 // checks color format and (single-plane or non-disjoint)
1005 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1006 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001007 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001008 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
1009 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
1010 ? "VUID-VkImageMemoryBarrier-image-01671"
1011 : "VUID-VkImageMemoryBarrier-image-02902";
1012 skip |= LogError(img_barrier.image, vuid,
1013 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
1014 "but its aspectMask is 0x%" PRIx32 ".",
1015 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1016 string_VkFormat(image_format), aspect_mask);
1017 }
1018 }
1019
1020 VkImageAspectFlags valid_disjoint_mask =
1021 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 -07001022 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001023 ((aspect_mask & valid_disjoint_mask) == 0)) {
1024 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
1025 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
1026 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
1027 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1028 string_VkFormat(image_format), aspect_mask);
1029 }
1030
1031 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
1032 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
1033 "%s: Image barrier %s references %s of format %s has only two planes but included "
1034 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
1035 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1036 string_VkFormat(image_format), aspect_mask);
1037 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001038 }
1039 }
1040 return skip;
1041}
1042
John Zulaufe3d1c8a2019-08-12 14:34:58 -06001043bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +02001044 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -07001045
Jeff Bolz6835fda2019-10-06 00:15:34 -05001046 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +02001047 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001048}
1049
John Zulauf6b4aae82018-05-09 13:03:36 -06001050template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001051bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
1052 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001053 using BarrierRecord = QFOTransferBarrier<Barrier>;
1054 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001055 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001056 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
1057 const char *barrier_name = BarrierRecord::BarrierName();
1058 const char *handle_name = BarrierRecord::HandleName();
1059 const char *transfer_type = nullptr;
1060 for (uint32_t b = 0; b < barrier_count; b++) {
1061 if (!IsTransferOp(&barriers[b])) continue;
1062 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001063 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001064 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001065 const auto found = barrier_sets.release.find(barriers[b]);
1066 if (found != barrier_sets.release.cend()) {
1067 barrier_record = &(*found);
1068 transfer_type = "releasing";
1069 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -06001070 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001071 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001072 const auto found = barrier_sets.acquire.find(barriers[b]);
1073 if (found != barrier_sets.acquire.cend()) {
1074 barrier_record = &(*found);
1075 transfer_type = "acquiring";
1076 }
1077 }
1078 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001079 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
1080 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1081 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
1082 func_name, barrier_name, b, transfer_type, handle_name,
1083 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
1084 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001085 }
1086 }
1087 return skip;
1088}
1089
John Zulaufa4472282019-08-22 14:44:34 -06001090VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1091 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1092}
1093
1094const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1095 return device_state.GetImageState(barrier.image);
1096}
1097
1098VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1099 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1100}
1101
1102const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1103 return device_state.GetBufferState(barrier.buffer);
1104}
1105
1106VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1107
John Zulauf6b4aae82018-05-09 13:03:36 -06001108template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001109void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1110 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001111 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001112 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1113 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001114 auto &barrier = barriers[b];
1115 if (IsTransferOp(&barrier)) {
1116 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001117 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001118 barrier_sets.release.emplace(barrier);
1119 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001120 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001121 barrier_sets.acquire.emplace(barrier);
1122 }
1123 }
1124
1125 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1126 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1127 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1128 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1129 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1130 auto handle_state = BarrierHandleState(*this, barrier);
1131 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1132 if (!mode_concurrent) {
1133 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001134 cb_state->queue_submit_functions.emplace_back(
1135 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1136 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1137 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1138 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001139 });
1140 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001141 }
1142 }
1143}
1144
John Zulaufa4472282019-08-22 14:44:34 -06001145bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001146 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001147 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001148 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001149 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001150 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1151 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001152 return skip;
1153}
1154
John Zulaufa4472282019-08-22 14:44:34 -06001155void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1156 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1157 const VkImageMemoryBarrier *pImageMemBarriers) {
1158 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1159 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001160}
1161
1162template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001163bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001164 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001165 // Record to the scoreboard or report that we have a duplication
1166 bool skip = false;
1167 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1168 if (!inserted.second && inserted.first->second != cb_state) {
1169 // 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 -06001170 LogObjectList objlist(cb_state->commandBuffer);
1171 objlist.add(barrier.handle);
1172 objlist.add(inserted.first->second->commandBuffer);
1173 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001174 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1175 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1176 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1177 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1178 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001179 }
1180 return skip;
1181}
1182
1183template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001184bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1185 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001186 using BarrierRecord = QFOTransferBarrier<Barrier>;
1187 using TypeTag = typename BarrierRecord::Tag;
1188 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001189 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001190 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001191 const char *barrier_name = BarrierRecord::BarrierName();
1192 const char *handle_name = BarrierRecord::HandleName();
1193 // No release should have an extant duplicate (WARNING)
1194 for (const auto &release : cb_barriers.release) {
1195 // Check the global pending release barriers
1196 const auto set_it = global_release_barriers.find(release.handle);
1197 if (set_it != global_release_barriers.cend()) {
1198 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1199 const auto found = set_for_handle.find(release);
1200 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001201 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1202 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1203 " to dstQueueFamilyIndex %" PRIu32
1204 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1205 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1206 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001207 }
1208 }
1209 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1210 }
1211 // Each acquire must have a matching release (ERROR)
1212 for (const auto &acquire : cb_barriers.acquire) {
1213 const auto set_it = global_release_barriers.find(acquire.handle);
1214 bool matching_release_found = false;
1215 if (set_it != global_release_barriers.cend()) {
1216 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1217 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1218 }
1219 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001220 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1221 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1222 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1223 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1224 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001225 }
1226 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1227 }
1228 return skip;
1229}
1230
John Zulauf3b04ebd2019-07-18 14:08:11 -06001231bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001232 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001233 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001234 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001235 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1236 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001237 return skip;
1238}
1239
1240template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001241void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001242 using BarrierRecord = QFOTransferBarrier<Barrier>;
1243 using TypeTag = typename BarrierRecord::Tag;
1244 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001245 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001246
1247 // Add release barriers from this submit to the global map
1248 for (const auto &release : cb_barriers.release) {
1249 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1250 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1251 global_release_barriers[release.handle].insert(release);
1252 }
1253
1254 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1255 for (const auto &acquire : cb_barriers.acquire) {
1256 // NOTE: We're not using [] because we don't want to create entries for missing releases
1257 auto set_it = global_release_barriers.find(acquire.handle);
1258 if (set_it != global_release_barriers.end()) {
1259 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1260 set_for_handle.erase(acquire);
1261 if (set_for_handle.size() == 0) { // Clean up empty sets
1262 global_release_barriers.erase(set_it);
1263 }
1264 }
1265 }
1266}
1267
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001268void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001269 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1270 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001271}
1272
John Zulauf6b4aae82018-05-09 13:03:36 -06001273// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001274void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001275
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001276void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001277 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001278 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001279 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001280
Chris Forbes4de4b132017-08-21 11:27:08 -07001281 // For ownership transfers, the barrier is specified twice; as a release
1282 // operation on the yielding queue family, and as an acquire operation
1283 // on the acquiring queue family. This barrier may also include a layout
1284 // transition, which occurs 'between' the two operations. For validation
1285 // purposes it doesn't seem important which side performs the layout
1286 // transition, but it must not be performed twice. We'll arbitrarily
1287 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001288 //
1289 // However, we still need to record initial layout for the "initial layout" validation
1290 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001291
Petr Krausad0096a2019-08-09 18:35:04 +02001292 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001293 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001294 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001295 }
1296}
1297
unknown86bcb3a2019-07-11 13:05:36 -06001298void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001299 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001300 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1301 const auto &image_create_info = image_state->createInfo;
1302
1303 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1304 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1305 // for all (potential) layer sub_resources.
1306 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1307 normalized_isr.baseArrayLayer = 0;
1308 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1309 }
1310
Michael Spang8af7c102020-05-03 20:50:09 -04001311 VkImageLayout initial_layout = mem_barrier.oldLayout;
1312
1313 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001314 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001315 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1316 }
1317
John Zulauf2be3fe02019-12-30 09:48:02 -07001318 if (is_release_op) {
1319 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1320 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001321 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001322 }
unknown86bcb3a2019-07-11 13:05:36 -06001323}
1324
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001325bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1326 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1327 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1328 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001329 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001330 assert(cb_node);
1331 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001332 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001333 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001334
John Zulauff660ad62019-03-23 07:16:05 -06001335 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1336 if (subresource_map) {
1337 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001338 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001339 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1340 // the next "constant value" range
1341 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001342 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001343 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001344 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1345 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1346 "%s layout %s.",
1347 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1348 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1349 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001350 }
John Zulauf5e617452019-11-19 14:44:16 -07001351 }
John Zulauff660ad62019-03-23 07:16:05 -06001352 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001353 }
John Zulauff660ad62019-03-23 07:16:05 -06001354
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001355 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1356 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1357 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001358 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1359 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001360 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1361 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1362 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001363 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001364 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001365 if (image_state->shared_presentable) {
1366 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001367 skip |=
1368 LogError(device, layout_invalid_msg_code,
1369 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1370 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001371 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001372 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001373 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001374 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001375 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1376 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1377 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1378 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001379 }
1380 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001381 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001382}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001383bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001384 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1385 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001386 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001387 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1388 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1389}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001390
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001391void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001392 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001393 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001394 if (!renderPass) return;
1395
Tobias Hectorbbb12282018-10-22 15:17:59 +01001396 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001397 if (framebuffer_state) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001398 IMAGE_VIEW_STATE *view_state = nullptr;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001399 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001400 if (framebuffer_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) {
1401 const auto attachment_info = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
1402 if (attachment_info) view_state = GetImageViewState(attachment_info->pAttachments[i]);
1403 } else {
Lionel Landwerlin484d10f2020-04-24 01:34:47 +03001404 view_state = GetAttachmentImageViewState(pCB, framebuffer_state, i);
Tony-LunarG61e7c0c2020-03-03 16:09:11 -07001405 }
John Zulauf8e308292018-09-21 11:34:37 -06001406 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001407 VkImageLayout stencil_layout = kInvalidLayout;
1408 const auto *attachment_description_stencil_layout =
1409 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1410 if (attachment_description_stencil_layout) {
1411 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1412 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001413 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001414 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001415 }
1416 }
1417}
Dave Houltone19e20d2018-02-02 16:32:41 -07001418
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001419#ifdef VK_USE_PLATFORM_ANDROID_KHR
1420// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1421// This could also move into a seperate core_validation_android.cpp file... ?
1422
1423//
1424// AHB-specific validation within non-AHB APIs
1425//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001426bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001427 bool skip = false;
1428
1429 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1430 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001431 if (0 != ext_fmt_android->externalFormat) {
1432 if (VK_FORMAT_UNDEFINED != create_info->format) {
1433 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001434 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1435 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1436 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001437 }
1438
1439 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001440 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1441 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1442 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001443 }
1444
1445 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001446 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1447 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001448 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1449 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1450 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001451 }
1452
1453 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001454 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1455 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1456 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001457 }
1458 }
1459
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001460 if ((0 != ext_fmt_android->externalFormat) &&
1461 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001462 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001463 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1464 ") which has "
1465 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1466 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001467 }
1468 }
1469
Dave Houltond9611312018-11-19 17:03:36 -07001470 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001471 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001472 skip |=
1473 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1474 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1475 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001476 }
1477 }
1478
1479 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1480 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1481 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001482 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001483 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1484 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1485 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1486 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001487 }
1488
1489 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001490 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1491 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1492 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1493 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1494 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001495 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001496 }
1497
1498 return skip;
1499}
1500
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001501bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001502 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001503 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001504
1505 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001506 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001507 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1508 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001509 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001510 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001511 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001512
Dave Houltond9611312018-11-19 17:03:36 -07001513 // Chain must include a compatible ycbcr conversion
1514 bool conv_found = false;
1515 uint64_t external_format = 0;
1516 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1517 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001518 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001519 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001520 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001521 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001522 }
Dave Houltond9611312018-11-19 17:03:36 -07001523 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001524 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001525 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001526 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1527 "an externalFormat (%" PRIu64
1528 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1529 "with the same external format.",
1530 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001531 }
1532
1533 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001534 if (IsIdentitySwizzle(create_info->components) == false) {
1535 skip |= LogError(
1536 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1537 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1538 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1539 "= %s.",
1540 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1541 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001542 }
1543 }
Dave Houltond9611312018-11-19 17:03:36 -07001544
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001545 return skip;
1546}
1547
John Zulaufa26d3c82019-08-14 16:09:08 -06001548bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001549 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001550
John Zulaufa26d3c82019-08-14 16:09:08 -06001551 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001552 if (image_state != nullptr) {
1553 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1554 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1555 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1556 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1557 "bound to memory.");
1558 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001559 }
1560 return skip;
1561}
1562
1563#else
1564
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001565bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001566 return false;
1567}
1568
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001569bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001570
John Zulaufa26d3c82019-08-14 16:09:08 -06001571bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001572
1573#endif // VK_USE_PLATFORM_ANDROID_KHR
1574
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001575bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1576 bool skip = false;
1577
1578 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1579 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1580 const VkImageTiling image_tiling = pCreateInfo->tiling;
1581 const VkFormat image_format = pCreateInfo->format;
1582
1583 if (image_format == VK_FORMAT_UNDEFINED) {
1584 // VU 01975 states format can't be undefined unless an android externalFormat
1585#ifdef VK_USE_PLATFORM_ANDROID_KHR
1586 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1587 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1588 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1589 if (it != ahb_ext_formats_map.end()) {
1590 tiling_features = it->second;
1591 }
1592 }
1593#endif
1594 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1595 uint64_t drm_format_modifier = 0;
1596 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1597 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1598 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1599 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1600
1601 if (drm_explicit != nullptr) {
1602 drm_format_modifier = drm_explicit->drmFormatModifier;
1603 } else {
1604 // VUID 02261 makes sure its only explict or implict in parameter checking
1605 assert(drm_implicit != nullptr);
1606 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1607 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1608 }
1609 }
1610
1611 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1612 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1613 nullptr};
1614 format_properties_2.pNext = (void *)&drm_properties_list;
1615 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001616 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1617 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1618 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1619 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001620
1621 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1622 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1623 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1624 }
1625 }
1626 } else {
1627 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1628 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1629 : format_properties.optimalTilingFeatures;
1630 }
1631
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001632 // Lack of disjoint format feature support while using the flag
1633 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1634 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1635 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1636 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1637 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1638 string_VkFormat(pCreateInfo->format));
1639 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001640
1641 return skip;
1642}
1643
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001644bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001645 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001646 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001647
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001648 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001649 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001650 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1651 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001652 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1653 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001654 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001655 }
1656
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001657 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1658 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001659 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1660 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1661 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001662 }
1663
1664 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001665 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1666 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1667 "height (%d) and arrayLayers (%d) must be >= 6.",
1668 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001669 }
Dave Houlton130c0212018-01-29 13:39:56 -07001670 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001671
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001672 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001673 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1674 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1675 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001676 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1677 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1678 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001679 }
1680
1681 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001682 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1683 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1684 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001685 }
1686
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001687 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
ByumjinConffx991b6062019-08-14 15:17:53 -07001688 uint32_t ceiling_width =
1689 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1690 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1691 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1692 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001693 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1694 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1695 "ceiling of device "
1696 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1697 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1698 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001699 }
1700
1701 uint32_t ceiling_height =
1702 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1703 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1704 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1705 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001706 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1707 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1708 "ceiling of device "
1709 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1710 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1711 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001712 }
1713 }
1714
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001715 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001716 VkResult result = VK_SUCCESS;
1717 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1718 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1719 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1720 &format_limits);
1721 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001722 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1723 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1724 if (modifier_list) {
1725 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1726 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1727 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1728 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1729 image_format_info.type = pCreateInfo->imageType;
1730 image_format_info.format = pCreateInfo->format;
1731 image_format_info.tiling = pCreateInfo->tiling;
1732 image_format_info.usage = pCreateInfo->usage;
1733 image_format_info.flags = pCreateInfo->flags;
1734 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1735
1736 result =
1737 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1738 format_limits = image_format_properties.imageFormatProperties;
1739
1740 /* The application gives a list of modifier and the driver
1741 * selects one. If one is wrong, stop there.
1742 */
1743 if (result != VK_SUCCESS) break;
1744 }
1745 } else if (explicit_modifier) {
1746 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1747 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1748 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1749 image_format_info.type = pCreateInfo->imageType;
1750 image_format_info.format = pCreateInfo->format;
1751 image_format_info.tiling = pCreateInfo->tiling;
1752 image_format_info.usage = pCreateInfo->usage;
1753 image_format_info.flags = pCreateInfo->flags;
1754 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1755
1756 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1757 format_limits = image_format_properties.imageFormatProperties;
1758 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001759 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001760
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001761 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1762 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1763 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1764 if (result != VK_SUCCESS) {
1765 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001766#ifdef VK_USE_PLATFORM_ANDROID_KHR
1767 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1768#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001769 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001770 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001771 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1772 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001773 } else {
1774 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1775 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001776 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1777 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1778 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001779 }
Dave Houlton130c0212018-01-29 13:39:56 -07001780
Dave Houltona585d132019-01-18 13:05:42 -07001781 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1782 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1783 (uint64_t)pCreateInfo->samples;
1784 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001785
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001786 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001787 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001788 uint64_t ig_mask = imageGranularity - 1;
1789 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001790
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001791 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001792 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1793 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1794 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1795 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001796 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001797
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001798 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001799 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1800 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1801 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001802 }
1803
1804 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001805 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1806 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1807 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001808 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001809
1810 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1811 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1812 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1813 pCreateInfo->extent.width, format_limits.maxExtent.width);
1814 }
1815
1816 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1817 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1818 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1819 pCreateInfo->extent.height, format_limits.maxExtent.height);
1820 }
1821
1822 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1823 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1824 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1825 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1826 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001827 }
1828
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001829 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001830 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1831 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1832 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1833 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001834 skip |= LogError(device, error_vuid,
1835 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1836 "YCbCr Conversion format, arrayLayers must be 1",
1837 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001838 }
1839
1840 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001841 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1842 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1843 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001844 }
1845
1846 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001847 skip |= LogError(
1848 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001849 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1850 string_VkSampleCountFlagBits(pCreateInfo->samples));
1851 }
1852
1853 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001854 skip |= LogError(
1855 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001856 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1857 string_VkImageType(pCreateInfo->imageType));
1858 }
1859 }
1860
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001861 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001862 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001863 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001864 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001865 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1866 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1867 "format must be block, ETC or ASTC compressed, but is %s",
1868 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001869 }
1870 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001871 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1872 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1873 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001874 }
1875 }
1876 }
1877
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001878 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001879 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1880 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
1881 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001882 }
1883
unknown2c877272019-07-11 12:56:50 -06001884 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1885 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1886 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001887 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1888 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1889 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001890 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001891
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001892 const auto swapchain_create_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1893 if (swapchain_create_info != nullptr) {
1894 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1895 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1896 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1897
1898 // Validate rest of Swapchain Image create check that require swapchain state
1899 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1900 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1901 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1902 skip |= LogError(
1903 device, vuid,
1904 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1905 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1906 }
1907 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1908 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1909 skip |= LogError(device, vuid,
1910 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1911 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1912 }
1913 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR);
1914 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1915 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1916 skip |= LogError(device, vuid,
1917 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1918 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
1919 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR flags both set.");
1920 }
1921 }
1922 }
1923
sfricke-samsungedce77a2020-07-03 22:35:13 -07001924 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1925 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1926 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1927 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1928 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1929 }
1930 const VkImageCreateFlags invalid_flags =
1931 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1932 if ((pCreateInfo->flags & invalid_flags) != 0) {
1933 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1934 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1935 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1936 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1937 }
1938 }
1939
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001940 skip |= ValidateImageFormatFeatures(pCreateInfo);
1941
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001942 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001943}
1944
John Zulauf7eeb6f72019-06-17 11:56:36 -06001945void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1946 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1947 if (VK_SUCCESS != result) return;
1948
1949 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001950 auto image_state = Get<IMAGE_STATE>(*pImage);
1951 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001952}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001953
Jeff Bolz5c801d12019-10-09 10:38:45 -05001954bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001955 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001956 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001957 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001958 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001959 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001960 }
1961 return skip;
1962}
1963
John Zulauf7eeb6f72019-06-17 11:56:36 -06001964void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1965 // Clean up validation specific data
1966 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001967
locke-lunargcba7d5f2019-12-30 16:59:11 -07001968 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001969
1970 // Clean up generic image state
1971 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001972}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001973
sfricke-samsungcd924d92020-05-20 23:51:17 -07001974bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
1975 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001976 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07001977 const VkImage image = image_state->image;
1978 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001979
1980 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001981 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
1982 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001983 }
1984
sfricke-samsungcd924d92020-05-20 23:51:17 -07001985 if (FormatIsDepthOrStencil(format)) {
1986 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1987 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
1988 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
1989 } else if (FormatIsCompressed(format)) {
1990 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
1991 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
1992 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001993 }
1994
1995 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001996 skip |=
1997 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
1998 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
1999 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002000 }
2001 return skip;
2002}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002003
John Zulauf07288512019-07-05 11:09:50 -06002004bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2005 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2006 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002007 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002008 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2009 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002010 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2011 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2012 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002013 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002014
2015 } else {
2016 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2017 if (!device_extensions.vk_khr_shared_presentable_image) {
2018 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002019 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2020 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2021 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002022 }
2023 } else {
2024 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2025 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002026 skip |= LogError(
2027 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002028 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2029 func_name, string_VkImageLayout(dest_image_layout));
2030 }
2031 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002032 }
2033
John Zulauff660ad62019-03-23 07:16:05 -06002034 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002035 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002036 if (subresource_map) {
2037 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002038 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002039 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
Tony Barbour55688172020-09-23 15:19:50 -07002040 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2041 // the next "constant value" range
2042 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002043 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002044 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2045 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2046 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2047 } else {
2048 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002049 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002050 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2051 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2052 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2053 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002054 }
John Zulauf5e617452019-11-19 14:44:16 -07002055 }
John Zulauff660ad62019-03-23 07:16:05 -06002056 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002057 }
2058
2059 return skip;
2060}
2061
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002062bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2063 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002064 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002065 bool skip = false;
2066 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002067 const auto *cb_node = GetCBState(commandBuffer);
2068 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002069 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002070 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002071 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002072 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002073 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002074 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002075 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2076 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002077 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002078 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002079 skip |=
2080 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2081 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2082 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002083 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002084 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002085 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002086 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002087 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002088 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002089 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2090 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2091 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2092 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2093 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2094 string_VkFormat(image_state->createInfo.format));
2095 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002096 }
2097 return skip;
2098}
2099
John Zulaufeabb4462019-07-05 14:13:03 -06002100void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2101 const VkClearColorValue *pColor, uint32_t rangeCount,
2102 const VkImageSubresourceRange *pRanges) {
2103 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2104
2105 auto cb_node = GetCBState(commandBuffer);
2106 auto image_state = GetImageState(image);
2107 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002108 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002109 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002110 }
2111 }
2112}
2113
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002114bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2115 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002116 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002117 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002118
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002119 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002120 const auto *cb_node = GetCBState(commandBuffer);
2121 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002122 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002123 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002124 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002125 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002126 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002127 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002128 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002129 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002130 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002131 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002132 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002133 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002134 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2135 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2136 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2137 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002138
2139 bool any_include_aspect_depth_bit = false;
2140 bool any_include_aspect_stencil_bit = false;
2141
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002142 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002143 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002144 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002145 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002146 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002147 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2148 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002149 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2150 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2151 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2152 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002153 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002154 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2155 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002156 if (FormatHasDepth(image_format) == false) {
2157 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2158 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2159 "doesn't have a depth component.",
2160 i, string_VkFormat(image_format));
2161 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002162 }
2163 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2164 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002165 if (FormatHasStencil(image_format) == false) {
2166 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2167 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2168 "%s doesn't have a stencil component.",
2169 i, string_VkFormat(image_format));
2170 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002171 }
2172 }
2173 if (any_include_aspect_stencil_bit) {
2174 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2175 if (image_stencil_struct != nullptr) {
2176 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2177 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002178 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2179 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2180 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2181 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002182 }
2183 } else {
2184 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002185 skip |= LogError(
2186 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002187 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2188 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2189 "in VkImageCreateInfo::usage used to create image");
2190 }
2191 }
2192 }
2193 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002194 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2195 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2196 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002197 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002198 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002199 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2200 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002201 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002202 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002203 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002204 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2205 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2206 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2207 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002208 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002209 }
2210 return skip;
2211}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002212
John Zulaufeabb4462019-07-05 14:13:03 -06002213void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2214 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2215 const VkImageSubresourceRange *pRanges) {
2216 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2217 auto cb_node = GetCBState(commandBuffer);
2218 auto image_state = GetImageState(image);
2219 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002220 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002221 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002222 }
2223 }
2224}
2225
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002226// Returns true if [x, xoffset] and [y, yoffset] overlap
2227static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2228 bool result = false;
2229 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2230 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2231
2232 if (intersection_max > intersection_min) {
2233 result = true;
2234 }
2235 return result;
2236}
2237
Jeff Leger178b1e52020-10-05 12:22:23 -04002238// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002239// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002240template <typename RegionType>
2241static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002242 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002243
Dave Houltonc991cc92018-03-06 11:08:51 -07002244 // Separate planes within a multiplane image cannot intersect
2245 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002246 return result;
2247 }
2248
Dave Houltonc991cc92018-03-06 11:08:51 -07002249 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2250 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2251 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002252 result = true;
2253 switch (type) {
2254 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002255 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002256 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002257 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002258 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002259 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002260 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002261 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002262 break;
2263 default:
2264 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2265 assert(false);
2266 }
2267 }
2268 return result;
2269}
2270
Dave Houltonfc1a4052017-04-27 14:32:45 -06002271// Returns non-zero if offset and extent exceed image extents
2272static const uint32_t x_bit = 1;
2273static const uint32_t y_bit = 2;
2274static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002275static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002276 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002277 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002278 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2279 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002280 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002281 }
2282 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2283 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002284 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002285 }
2286 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2287 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002288 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002289 }
2290 return result;
2291}
2292
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002293// Test if two VkExtent3D structs are equivalent
2294static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2295 bool result = true;
2296 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2297 (extent->depth != other_extent->depth)) {
2298 result = false;
2299 }
2300 return result;
2301}
2302
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002303// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002304static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002305 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2306}
2307
2308// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002309VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002310 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2311 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002312 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002313 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002314 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002315 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002316 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002317 granularity.width *= block_size.width;
2318 granularity.height *= block_size.height;
2319 }
2320 }
2321 return granularity;
2322}
2323
2324// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2325static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2326 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002327 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2328 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002329 valid = false;
2330 }
2331 return valid;
2332}
2333
2334// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002335bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002336 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002337 bool skip = false;
2338 VkExtent3D offset_extent = {};
2339 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2340 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2341 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002342 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002343 // 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 -07002344 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002345 skip |= LogError(cb_node->commandBuffer, vuid,
2346 "%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 "
2347 "image transfer granularity is (w=0, h=0, d=0).",
2348 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002349 }
2350 } else {
2351 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2352 // integer multiples of the image transfer granularity.
2353 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002354 skip |= LogError(cb_node->commandBuffer, vuid,
2355 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2356 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2357 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2358 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002359 }
2360 }
2361 return skip;
2362}
2363
2364// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002365bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002366 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002367 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002368 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002369 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002370 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2371 // subresource extent.
2372 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002373 skip |= LogError(cb_node->commandBuffer, vuid,
2374 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2375 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2376 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2377 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002378 }
2379 } else {
2380 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2381 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2382 // subresource extent dimensions.
2383 VkExtent3D offset_extent_sum = {};
2384 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2385 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2386 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002387 bool x_ok = true;
2388 bool y_ok = true;
2389 bool z_ok = true;
2390 switch (image_type) {
2391 case VK_IMAGE_TYPE_3D:
2392 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2393 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002394 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002395 case VK_IMAGE_TYPE_2D:
2396 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2397 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002398 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002399 case VK_IMAGE_TYPE_1D:
2400 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2401 (subresource_extent->width == offset_extent_sum.width));
2402 break;
2403 default:
2404 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2405 assert(false);
2406 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002407 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002408 skip |=
2409 LogError(cb_node->commandBuffer, vuid,
2410 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2411 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2412 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2413 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2414 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2415 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002416 }
2417 }
2418 return skip;
2419}
2420
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002421bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002422 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002423 bool skip = false;
2424 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002425 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2426 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002427 }
2428 return skip;
2429}
2430
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002431bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002432 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002433 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002434 bool skip = false;
2435 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2436 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002437 skip |= LogError(cb_node->commandBuffer, vuid,
2438 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2439 "%u, but provided %s has %u array layers.",
2440 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2441 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002442 }
2443 return skip;
2444}
2445
Jeff Leger178b1e52020-10-05 12:22:23 -04002446// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2447template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002448bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002449 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002450 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002451 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002452 VkExtent3D granularity = GetScaledItg(cb_node, img);
2453 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002454 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002455 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002456 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002457 return skip;
2458}
2459
Jeff Leger178b1e52020-10-05 12:22:23 -04002460// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2461template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002462bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002463 const IMAGE_STATE *dst_img, const RegionType *region,
2464 const uint32_t i, const char *function,
2465 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002466 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002467 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2468 const char *vuid;
2469
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002470 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002471 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002472 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2473 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002474 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002475 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002476 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002477 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002478 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002479
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002480 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002481 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002482 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2483 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002484 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002485 const VkExtent3D dest_effective_extent =
2486 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002487 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002488 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002489 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002490 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002491 return skip;
2492}
2493
Jeff Leger178b1e52020-10-05 12:22:23 -04002494// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2495template <typename ImageCopyRegionType>
2496bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2497 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2498 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002499 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002500 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2501 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2502 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002503
2504 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002505 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002506
2507 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002508 const VkExtent3D src_copy_extent = region.extent;
2509 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002510 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2511
Dave Houlton6f9059e2017-05-02 17:15:13 -06002512 bool slice_override = false;
2513 uint32_t depth_slices = 0;
2514
2515 // Special case for copying between a 1D/2D array and a 3D image
2516 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2517 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002518 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002519 slice_override = (depth_slices != 1);
2520 } 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 -07002521 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002522 slice_override = (depth_slices != 1);
2523 }
2524
2525 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002526 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002527 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002528 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2529 skip |= LogError(src_state->image, vuid,
2530 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2531 "be 0 and 1, respectively.",
2532 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002533 }
2534 }
2535
Dave Houlton533be9f2018-03-26 17:08:30 -06002536 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 -04002537 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2538 skip |= LogError(src_state->image, vuid,
2539 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002540 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002541 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002542 }
2543
Dave Houlton533be9f2018-03-26 17:08:30 -06002544 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002545 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2546 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2547 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002548 }
2549
Dave Houltonc991cc92018-03-06 11:08:51 -07002550 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002551 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002552 if (FormatIsCompressed(src_state->createInfo.format) ||
2553 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002554 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002555 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002556 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2557 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2558 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002559 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002560 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002561 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002562 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002563 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002564 }
2565
Dave Houlton94a00372017-12-14 15:08:47 -07002566 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002567 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2568 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002569 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2570 skip |= LogError(src_state->image, vuid,
2571 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2572 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2573 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002574 }
2575
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002576 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002577 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2578 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002579 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2580 skip |= LogError(src_state->image, vuid,
2581 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2582 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2583 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002584 }
2585
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002586 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002587 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2588 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002589 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2590 skip |= LogError(src_state->image, vuid,
2591 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2592 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2593 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002594 }
2595 } // Compressed
2596
2597 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002598 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002599 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002600 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2601 skip |= LogError(dst_state->image, vuid,
2602 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002603 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002604 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002605 }
2606 }
2607
Dave Houlton533be9f2018-03-26 17:08:30 -06002608 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 -04002609 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2610 skip |= LogError(dst_state->image, vuid,
2611 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2612 "and 1, respectively.",
2613 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002614 }
2615
Dave Houlton533be9f2018-03-26 17:08:30 -06002616 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002617 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2618 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2619 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002620 }
2621
sfricke-samsung30b094c2020-05-30 11:42:11 -07002622 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002623 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002624 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2625 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002626 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
2627 skip |= LogError(src_state->image, vuid,
2628 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2629 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2630 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002631 }
2632 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002633 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002634 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002635 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
2636 skip |= LogError(dst_state->image, vuid,
2637 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2638 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2639 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002640 }
2641 }
2642 } else { // Pre maint 1
2643 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002644 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002645 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2646 skip |= LogError(src_state->image, vuid,
2647 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002648 "srcSubresource.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.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002651 }
Dave Houltonee281a52017-12-08 13:51:02 -07002652 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002653 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2654 skip |= LogError(dst_state->image, vuid,
2655 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002656 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2657 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002658 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002659 }
2660 }
2661 }
2662
Dave Houltonc991cc92018-03-06 11:08:51 -07002663 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2664 if (FormatIsCompressed(dst_state->createInfo.format) ||
2665 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002666 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002667
2668 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002669 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2670 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2671 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002672 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002673 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002674 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002675 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002676 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002677 }
2678
Dave Houlton94a00372017-12-14 15:08:47 -07002679 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002680 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2681 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002682 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
2683 skip |= LogError(dst_state->image, vuid,
2684 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2685 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2686 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002687 }
2688
Dave Houltonee281a52017-12-08 13:51:02 -07002689 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2690 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2691 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002692 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002693 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002694 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002695 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2696 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002697 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002698 }
2699
Dave Houltonee281a52017-12-08 13:51:02 -07002700 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2701 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2702 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002703 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
2704 skip |= LogError(dst_state->image, vuid,
2705 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2706 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2707 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002708 }
2709 } // Compressed
2710 }
2711 return skip;
2712}
2713
Jeff Leger178b1e52020-10-05 12:22:23 -04002714// vkCmdCopyImage / vmCmdCopyImage2KHR checks that only apply if the multiplane extension is enabled
2715template <typename RegionType>
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002716bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04002717 const IMAGE_STATE *dst_image_state, const RegionType region,
2718 CopyCommandVersion version) const {
2719 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Dave Houltonc991cc92018-03-06 11:08:51 -07002720 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002721
Jeff Leger178b1e52020-10-05 12:22:23 -04002722 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2723 const char *vuid;
2724
Dave Houltonc991cc92018-03-06 11:08:51 -07002725 // Neither image is multiplane
2726 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2727 // If neither image is multi-plane the aspectMask member of src and dst must match
2728 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2729 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002730 ss << func_name << ": Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002731 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Jeff Leger178b1e52020-10-05 12:22:23 -04002732 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2733 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002734 }
2735 } else {
2736 // Source image multiplane checks
2737 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2738 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2739 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2740 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002741 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2742 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2743 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002744 }
2745 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2746 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2747 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002748 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2749 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2750 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002751 }
2752 // Single-plane to multi-plane
2753 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2754 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2755 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002756 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2757 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2758 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002759 }
2760
2761 // Dest image multiplane checks
2762 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2763 aspect = region.dstSubresource.aspectMask;
2764 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2765 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002766 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2767 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2768 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002769 }
2770 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2771 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2772 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002773 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2774 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2775 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002776 }
2777 // Multi-plane to single-plane
2778 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2779 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2780 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002781 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2782 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
2783 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002784 }
2785 }
2786
2787 return skip;
2788}
2789
Jeff Leger178b1e52020-10-05 12:22:23 -04002790template <typename RegionType>
2791bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2792 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2793 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002794 const auto *cb_node = GetCBState(commandBuffer);
2795 const auto *src_image_state = GetImageState(srcImage);
2796 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002797 const VkFormat src_format = src_image_state->createInfo.format;
2798 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002799 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002800 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002801
Jeff Leger178b1e52020-10-05 12:22:23 -04002802 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2803 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2804 const char *vuid;
2805
2806 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002807
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002808 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2809
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002810 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002811 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002812
2813 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2814 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002815 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002816
Dave Houlton6f9059e2017-05-02 17:15:13 -06002817 bool slice_override = false;
2818 uint32_t depth_slices = 0;
2819
2820 // Special case for copying between a 1D/2D array and a 3D image
2821 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2822 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2823 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002824 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002825 slice_override = (depth_slices != 1);
2826 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2827 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002828 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002829 slice_override = (depth_slices != 1);
2830 }
2831
Jeff Leger178b1e52020-10-05 12:22:23 -04002832 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2833 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2834 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2835 skip |=
2836 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2837 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2838 skip |=
2839 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2840 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002841 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002842 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2843 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002844 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002845 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002846
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002847 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002848 // No chance of mismatch if we're overriding depth slice count
2849 if (!slice_override) {
2850 // The number of depth slices in srcSubresource and dstSubresource must match
2851 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2852 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002853 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2854 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002855 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002856 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2857 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002858 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002859 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2860 skip |= LogError(command_buffer, vuid,
2861 "%s: number of depth slices in source and destination subresources for "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002862 "pRegions[%u] do not match.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002863 func_name, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002864 }
2865 }
2866 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002867 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002868 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002869 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
2870 skip |= LogError(command_buffer, vuid,
2871 "%s: number of layers in source and destination subresources for pRegions[%u] do not match",
2872 func_name, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002873 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002874 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002875
Dave Houltonc991cc92018-03-06 11:08:51 -07002876 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002877 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002878 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region, version);
Dave Houltonc991cc92018-03-06 11:08:51 -07002879 }
2880
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002881 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002882 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2883 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002884 std::stringstream ss;
2885 ss << func_name << ": Src and dest aspectMasks for each region must match";
2886 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
2887 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonf5217612018-02-02 16:18:52 -07002888 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002889 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002890
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002891 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002892 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002893 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002894 ss << func_name << ": pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002895 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Jeff Leger178b1e52020-10-05 12:22:23 -04002896 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
2897 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002898 }
2899
2900 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002901 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002902 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002903 ss << func_name << ": pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2904 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
2905 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002906 }
2907
Dave Houltonfc1a4052017-04-27 14:32:45 -06002908 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002909 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2910 if (slice_override) src_copy_extent.depth = depth_slices;
2911 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002912 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002913 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
2914 skip |= LogError(command_buffer, vuid,
2915 "%s: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2916 "width [%1d].",
2917 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002918 }
2919
2920 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002921 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
2922 skip |= LogError(command_buffer, vuid,
2923 "%s: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2924 "height [%1d].",
2925 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002926 }
2927 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002928 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
2929 skip |= LogError(command_buffer, vuid,
2930 "%s: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2931 "depth [%1d].",
2932 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002933 }
2934
Dave Houltonee281a52017-12-08 13:51:02 -07002935 // Adjust dest extent if necessary
2936 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2937 if (slice_override) dst_copy_extent.depth = depth_slices;
2938
2939 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002940 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002941 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
2942 skip |= LogError(command_buffer, vuid,
2943 "%s: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002944 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002945 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002946 }
2947 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002948 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
2949 skip |= LogError(command_buffer, vuid,
2950 "%s): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002951 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002952 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002953 }
2954 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002955 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
2956 skip |= LogError(command_buffer, vuid,
2957 "%s: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002958 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002959 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002960 }
2961
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002962 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2963 // must not overlap in memory
2964 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002965 for (uint32_t j = 0; j < regionCount; j++) {
2966 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002967 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002968 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002969 ss << func_name << ": pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2970 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
2971 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002972 }
2973 }
2974 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002975
2976 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2977 if (device_extensions.vk_khr_maintenance1) {
2978 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2979 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2980 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002981 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
2982 skip |= LogError(command_buffer, vuid,
2983 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
2984 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08002985 }
2986 } else {
2987 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
2988 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2989 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002990 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
2991 skip |= LogError(command_buffer, vuid,
2992 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
2993 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08002994 }
2995 }
2996
2997 // Check if 2D with 3D and depth not equal to 2D layerCount
2998 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2999 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3000 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003001 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3002 skip |= LogError(command_buffer, vuid,
3003 "%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 -08003004 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003005 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003006 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3007 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3008 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003009 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3010 skip |= LogError(command_buffer, vuid,
3011 "%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 -08003012 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003013 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003014 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003015
3016 // Check for multi-plane format compatiblity
3017 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3018 size_t src_format_size = 0;
3019 size_t dst_format_size = 0;
3020 if (FormatIsMultiplane(src_format)) {
3021 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3022 src_format_size = FormatElementSize(planeFormat);
3023 } else {
3024 src_format_size = FormatElementSize(src_format);
3025 }
3026 if (FormatIsMultiplane(dst_format)) {
3027 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3028 dst_format_size = FormatElementSize(planeFormat);
3029 } else {
3030 dst_format_size = FormatElementSize(dst_format);
3031 }
3032 // If size is still zero, then format is invalid and will be caught in another VU
3033 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003034 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3035 skip |= LogError(command_buffer, vuid,
3036 "%s: pRegions[%u] called with non-compatible image formats. "
3037 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3038 func_name, i, string_VkFormat(src_format),
3039 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3040 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003041 }
3042 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003043 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003044
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003045 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3046 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3047 // because because both texels are 4 bytes in size.
3048 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003049 const char *compatible_vuid =
3050 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3051 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3052 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003053 // Depth/stencil formats must match exactly.
3054 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3055 if (src_format != dst_format) {
3056 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003057 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003058 string_VkFormat(src_format), string_VkFormat(dst_format));
3059 }
3060 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003061 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003062 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003063 "%s: Unmatched image format sizes. "
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003064 "The src format %s has size of %zu and dst format %s has size of %zu.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003065 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003066 FormatElementSize(dst_format));
3067 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003068 }
3069 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003070
Dave Houlton33c22b72017-02-28 13:16:02 -07003071 // Source and dest image sample counts must match
3072 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003073 std::stringstream ss;
3074 ss << func_name << " called on image pair with non-identical sample counts.";
3075 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
3076 skip |= LogError(command_buffer, vuid, "%s", ss.str().c_str());
Dave Houlton33c22b72017-02-28 13:16:02 -07003077 }
3078
Jeff Leger178b1e52020-10-05 12:22:23 -04003079 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127";
3080 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3081 vuid = is_2khr ? "" : "";
3082 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003083 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003084 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3085 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3086 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3087 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3088 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3089 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3090 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3091 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3092 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3093 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3094 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3095 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003096
3097 // Validation for VK_EXT_fragment_density_map
3098 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003099 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3100 skip |=
3101 LogError(command_buffer, vuid,
3102 "%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 +02003103 }
3104 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003105 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3106 skip |=
3107 LogError(command_buffer, vuid,
3108 "%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 +02003109 }
3110
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003111 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003112 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3113 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3114 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3115 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003116 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003117 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImage-commandBuffer-cmdpool";
3118 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
3119 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3120 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-renderpass" : "VUID-vkCmdCopyImage-renderpass";
3121 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003122 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003123
3124 const char *invalid_src_layout_vuid =
3125 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3126 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3127 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3128 const char *invalid_dst_layout_vuid =
3129 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3130 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3131 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3132
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003133 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003134 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003135 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003136 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3137 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003138 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003139 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003140 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003141 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003142 }
3143
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003144 return skip;
3145}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003146
Jeff Leger178b1e52020-10-05 12:22:23 -04003147bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3148 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3149 const VkImageCopy *pRegions) const {
3150 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3151 COPY_COMMAND_VERSION_1);
3152}
3153
3154bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3155 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3156 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3157 COPY_COMMAND_VERSION_2);
3158}
3159
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003160void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3161 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3162 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003163 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3164 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003165 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003166 auto src_image_state = GetImageState(srcImage);
3167 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003168
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003169 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003170 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003171 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3172 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003173 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003174}
3175
Jeff Leger178b1e52020-10-05 12:22:23 -04003176void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3177 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3178 auto cb_node = GetCBState(commandBuffer);
3179 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3180 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3181
3182 // Make sure that all image slices are updated to correct layout
3183 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3184 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3185 pCopyImageInfo->srcImageLayout);
3186 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3187 pCopyImageInfo->dstImageLayout);
3188 }
3189}
3190
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003191// Returns true if sub_rect is entirely contained within rect
3192static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3193 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
3194 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
3195 return false;
3196 return true;
3197}
3198
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003199bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003200 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
3201 const VkRect2D &render_area, uint32_t rect_count,
3202 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003203 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003204 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3205 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Tony-LunarG14370e52020-04-28 12:16:21 -06003206 image_view_state = GetAttachmentImageViewState(GetCBState(command_buffer), framebuffer, fb_attachment);
John Zulauff2582972019-02-09 14:53:30 -07003207 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003208
3209 for (uint32_t j = 0; j < rect_count; j++) {
3210 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003211 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3212 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3213 "the current render pass instance.",
3214 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003215 }
3216
3217 if (image_view_state) {
3218 // The layers specified by a given element of pRects must be contained within every attachment that
3219 // pAttachments refers to
3220 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3221 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3222 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003223 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3224 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3225 "of pAttachment[%d].",
3226 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003227 }
3228 }
3229 }
3230 return skip;
3231}
3232
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003233bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3234 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003235 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003236 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003237 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003238 if (!cb_node) return skip;
3239
3240 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3241 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3242 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003243 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003244
3245 // Validate that attachment is in reference list of active subpass
3246 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003247 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003248 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003249 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003250 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003251 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003252
John Zulauf3a548ef2019-02-01 16:14:07 -07003253 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3254 auto clear_desc = &pAttachments[attachment_index];
3255 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003256 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003257
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003258 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3259 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3260 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3261 attachment_index);
3262 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3263 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3264 skip |=
3265 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3266 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3267 attachment_index);
3268 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003269 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3270 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3271 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3272 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003273 skip |= LogError(
3274 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3275 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3276 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3277 attachment_index, clear_desc->colorAttachment,
3278 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3279 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003280
John Zulauff2582972019-02-09 14:53:30 -07003281 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3282 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003283 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003284 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3285 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3286 " subpass %u. colorAttachmentCount=%u",
3287 attachment_index, clear_desc->colorAttachment,
3288 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3289 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003290 }
John Zulauff2582972019-02-09 14:53:30 -07003291 fb_attachment = color_attachment;
3292
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003293 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) || (aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003294 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003295 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003296 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003297 }
3298 } else { // Must be depth and/or stencil
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003299 if (!subpass_desc->pDepthStencilAttachment ||
3300 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003301 skip |= LogPerformanceWarning(
3302 commandBuffer, kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003303 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003304 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003305 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003306 }
3307 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003308 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003309 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3310 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003311 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003312
3313 // Once the framebuffer attachment is found, can get the image view state
3314 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3315 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3316 const IMAGE_VIEW_STATE *image_view_state =
3317 GetAttachmentImageViewState(GetCBState(commandBuffer), framebuffer, fb_attachment);
3318 if (image_view_state != nullptr) {
3319 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3320 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3321 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3322 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3323 }
3324 }
John Zulauf441558b2019-08-12 11:47:39 -06003325 }
3326 }
3327 return skip;
3328}
3329
3330void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3331 const VkClearAttachment *pAttachments, uint32_t rectCount,
3332 const VkClearRect *pRects) {
3333 auto *cb_node = GetCBState(commandBuffer);
3334 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3335 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3336 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3337 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3338 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3339 const auto clear_desc = &pAttachments[attachment_index];
3340 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3341 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3342 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3343 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3344 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3345 subpass_desc->pDepthStencilAttachment) {
3346 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3347 }
3348 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003349 if (!clear_rect_copy) {
3350 // We need a copy of the clear rectangles that will persist until the last lambda executes
3351 // but we want to create it as lazily as possible
3352 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003353 }
John Zulauf441558b2019-08-12 11:47:39 -06003354 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3355 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003356 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003357 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003358 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003359 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3360 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003361 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
3362 clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003363 return skip;
3364 };
3365 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003366 }
3367 }
3368 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003369}
3370
Jeff Leger178b1e52020-10-05 12:22:23 -04003371template <typename RegionType>
3372bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3373 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3374 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003375 const auto *cb_node = GetCBState(commandBuffer);
3376 const auto *src_image_state = GetImageState(srcImage);
3377 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003378 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3379 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3380 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3381 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003382
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003383 bool skip = false;
3384 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003385 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3386 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3387 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3388 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3389 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdResolveImage-commandBuffer-cmdpool";
3390 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3391 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3392 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-renderpass" : "VUID-vkCmdResolveImage-renderpass";
3393 skip |= InsideRenderPass(cb_node, func_name, vuid);
3394 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3395 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3396 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3397 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3398 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3399 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3400 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3401 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003402
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003403 // Validation for VK_EXT_fragment_density_map
3404 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003405 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3406 skip |= LogError(cb_node->commandBuffer, vuid,
3407 "%s: srcImage must not have been created with flags containing "
3408 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3409 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003410 }
3411 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003412 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3413 skip |= LogError(cb_node->commandBuffer, vuid,
3414 "%s: dstImage must not have been created with flags containing "
3415 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3416 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003417 }
3418
Cort Stratton7df30962018-05-17 19:45:57 -07003419 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003420 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003421 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3422 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003423 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003424 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3425 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3426 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003427 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003428 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3429 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3430 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3431 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3432 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3433 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003434 // For each region, the number of layers in the image subresource should not be zero
3435 // For each region, src and dest image aspect must be color only
3436 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003437 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003438 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3439 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003440 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3441 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3442 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003443 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003444 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3445 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003446 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003447 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3448 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3449 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3450 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3451 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3452 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003453 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003454 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3455 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003456 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003457 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003458
3459 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003460 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003461 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3462 skip |=
3463 LogError(cb_node->commandBuffer, vuid,
3464 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003465 }
Cort Stratton7df30962018-05-17 19:45:57 -07003466 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003467 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3468 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003469 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3470 skip |= LogError(cb_node->commandBuffer, vuid,
3471 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3472 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003473 }
3474
3475 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3476 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3477
3478 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003479 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003480 LogObjectList objlist(cb_node->commandBuffer);
3481 objlist.add(src_image_state->image);
3482 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003483 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3484 skip |= LogError(objlist, vuid,
3485 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003486 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003487 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003488 }
3489 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3490 LogObjectList objlist(cb_node->commandBuffer);
3491 objlist.add(src_image_state->image);
3492 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003493 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3494 skip |= LogError(objlist, vuid,
3495 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003496 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003497 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003498 }
3499 }
3500
3501 if (VK_IMAGE_TYPE_1D == src_image_type) {
3502 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3503 LogObjectList objlist(cb_node->commandBuffer);
3504 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003505 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3506 skip |= LogError(objlist, vuid,
3507 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003508 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003509 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3510 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003511 }
3512 }
3513 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3514 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3515 LogObjectList objlist(cb_node->commandBuffer);
3516 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003517 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3518 skip |= LogError(objlist, vuid,
3519 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003520 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003521 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3522 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003523 }
3524 }
3525
3526 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3527 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3528 LogObjectList objlist(cb_node->commandBuffer);
3529 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003530 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3531 skip |= LogError(objlist, vuid,
3532 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003533 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003534 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3535 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003536 }
3537 }
3538 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3539 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3540 LogObjectList objlist(cb_node->commandBuffer);
3541 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003542 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3543 skip |= LogError(objlist, vuid,
3544 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003545 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003546 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3547 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003548 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003549 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003550
3551 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3552 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3553 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3554 // developer
3555 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3556 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
3557 if ((extent_check & x_bit) != 0) {
3558 LogObjectList objlist(cb_node->commandBuffer);
3559 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003560 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3561 skip |= LogError(objlist, vuid,
3562 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003563 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003564 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003565 region.extent.width, subresource_extent.width);
3566 }
3567
3568 if ((extent_check & y_bit) != 0) {
3569 LogObjectList objlist(cb_node->commandBuffer);
3570 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003571 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3572 skip |= LogError(objlist, vuid,
3573 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003574 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003575 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003576 region.extent.height, subresource_extent.height);
3577 }
3578
3579 if ((extent_check & z_bit) != 0) {
3580 LogObjectList objlist(cb_node->commandBuffer);
3581 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003582 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3583 skip |= LogError(objlist, vuid,
3584 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003585 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003586 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003587 region.extent.depth, subresource_extent.depth);
3588 }
3589 }
3590
3591 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3592 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3593 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3594 // developer
3595 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3596 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
3597 if ((extent_check & x_bit) != 0) {
3598 LogObjectList objlist(cb_node->commandBuffer);
3599 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003600 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3601 skip |= LogError(objlist, vuid,
3602 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003603 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003604 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003605 region.extent.width, subresource_extent.width);
3606 }
3607
3608 if ((extent_check & y_bit) != 0) {
3609 LogObjectList objlist(cb_node->commandBuffer);
3610 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003611 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3612 skip |= LogError(objlist, vuid,
3613 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003614 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003615 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003616 region.extent.height, subresource_extent.height);
3617 }
3618
3619 if ((extent_check & z_bit) != 0) {
3620 LogObjectList objlist(cb_node->commandBuffer);
3621 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003622 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3623 skip |= LogError(objlist, vuid,
3624 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003625 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003626 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003627 region.extent.depth, subresource_extent.depth);
3628 }
3629 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003630 }
3631
3632 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003633 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
3634 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
3635 func_name, string_VkFormat(src_image_state->createInfo.format),
3636 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003637 }
3638 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003639 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003640 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003641 string_VkImageType(src_image_state->createInfo.imageType),
3642 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003643 }
3644 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003645 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
3646 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 -07003647 }
3648 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003649 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
3650 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3651 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003652 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003653 } else {
3654 assert(0);
3655 }
3656 return skip;
3657}
3658
Jeff Leger178b1e52020-10-05 12:22:23 -04003659bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3660 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3661 const VkImageResolve *pRegions) const {
3662 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3663 COPY_COMMAND_VERSION_1);
3664}
3665
3666bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3667 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3668 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3669 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3670 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3671}
3672
3673template <typename RegionType>
3674bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3675 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3676 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003677 const auto *cb_node = GetCBState(commandBuffer);
3678 const auto *src_image_state = GetImageState(srcImage);
3679 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003680
Jeff Leger178b1e52020-10-05 12:22:23 -04003681 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3682 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3683 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3684
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003685 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003686 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003687 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003688 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003689 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003690 const char *vuid;
3691 const char *location;
3692 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3693 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3694 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3695 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3696 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3697 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3698 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3699 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3700 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3701 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3702 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3703 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3704 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3705 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3706 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3707 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3708 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdBlitImage-commandBuffer-cmdpool";
3709 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3710 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3711 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-renderpass" : "VUID-vkCmdBlitImage-renderpass";
3712 skip |= InsideRenderPass(cb_node, func_name, vuid);
3713 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3714 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3715 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3716 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3717 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3718 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3719 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3720 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3721 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3722 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003723
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003724 // Validation for VK_EXT_fragment_density_map
3725 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003726 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3727 skip |= LogError(cb_node->commandBuffer, vuid,
3728 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3729 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003730 }
3731 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003732 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3733 skip |= LogError(cb_node->commandBuffer, vuid,
3734 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3735 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003736 }
3737
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003738 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003739
Dave Houlton33c2d252017-06-09 17:08:32 -06003740 VkFormat src_format = src_image_state->createInfo.format;
3741 VkFormat dst_format = dst_image_state->createInfo.format;
3742 VkImageType src_type = src_image_state->createInfo.imageType;
3743 VkImageType dst_type = dst_image_state->createInfo.imageType;
3744
Cort Stratton186b1a22018-05-01 20:18:06 -04003745 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003746 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3747 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3748 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003749 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003750 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003751 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003752 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003753 }
3754
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003755 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003756 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3757 skip |= LogError(device, vuid,
3758 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003759 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003760 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003761 }
3762
3763 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003764 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
3765 skip |= LogError(device, vuid,
3766 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003767 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003768 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003769 }
3770
Dave Houlton33c2d252017-06-09 17:08:32 -06003771 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003772 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
3773 skip |= LogError(cb_node->commandBuffer, vuid,
3774 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003775 }
3776
Dave Houlton33c2d252017-06-09 17:08:32 -06003777 // Validate consistency for unsigned formats
3778 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3779 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003780 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003781 << "the other one must also have unsigned integer format. "
3782 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003783 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
3784 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003785 }
3786
3787 // Validate consistency for signed formats
3788 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3789 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003790 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003791 << "the other one must also have signed integer format. "
3792 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003793 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
3794 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003795 }
3796
3797 // Validate filter for Depth/Stencil formats
3798 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3799 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003800 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003801 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003802 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
3803 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003804 }
3805
3806 // Validate aspect bits and formats for depth/stencil images
3807 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3808 if (src_format != dst_format) {
3809 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003810 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 -06003811 << "stencil, the other one must have exactly the same format. "
3812 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3813 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003814 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
3815 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003816 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003817 } // Depth or Stencil
3818
3819 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003820 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003821 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3822 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
3823 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
3824 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3825 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3826 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003827 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003828 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3829 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
3830 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
3831 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3832 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3833 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003834 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003835 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003836 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003837 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003838 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003839 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3840 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003841 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003842 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3843 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
3844 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
3845 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
3846 skip |=
3847 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3848 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
3849 skip |=
3850 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3851 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003852 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003853 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3854 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003855 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003856 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003857 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003858 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3859 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003860 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003861 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003862 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003863 }
Dave Houlton48989f32017-05-26 15:01:46 -06003864 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3865 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003866 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003867 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003868 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003869 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003870
3871 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003872 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003873 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
3874 skip |=
3875 LogError(cb_node->commandBuffer, vuid,
3876 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003877 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003878
Dave Houlton48989f32017-05-26 15:01:46 -06003879 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003880 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
3881 skip |=
3882 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003883 }
Dave Houlton48989f32017-05-26 15:01:46 -06003884
Dave Houlton33c2d252017-06-09 17:08:32 -06003885 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003886 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
3887 skip |= LogError(cb_node->commandBuffer, vuid,
3888 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003889 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003890 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003891 }
3892
3893 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003894 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
3895 skip |= LogError(cb_node->commandBuffer, vuid,
3896 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3897 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003898 }
3899
Dave Houlton48989f32017-05-26 15:01:46 -06003900 // Validate source image offsets
3901 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003902 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003903 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003904 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
3905 skip |= LogError(cb_node->commandBuffer, vuid,
3906 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3907 "of (%1d, %1d). These must be (0, 1).",
3908 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003909 }
3910 }
3911
Dave Houlton33c2d252017-06-09 17:08:32 -06003912 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003913 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003914 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
3915 skip |= LogError(cb_node->commandBuffer, vuid,
3916 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3917 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3918 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003919 }
3920 }
3921
Dave Houlton33c2d252017-06-09 17:08:32 -06003922 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003923 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3924 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003925 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003926 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
3927 skip |= LogError(cb_node->commandBuffer, vuid,
3928 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
3929 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003930 }
3931 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3932 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003933 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003934 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
3935 skip |= LogError(cb_node->commandBuffer, vuid,
3936 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
3937 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003938 }
3939 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3940 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003941 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003942 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
3943 skip |= LogError(cb_node->commandBuffer, vuid,
3944 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
3945 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003946 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003947 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003948 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
3949 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
3950 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003951 }
Dave Houlton48989f32017-05-26 15:01:46 -06003952
3953 // Validate dest image offsets
3954 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003955 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003956 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003957 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
3958 skip |= LogError(cb_node->commandBuffer, vuid,
3959 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3960 "(%1d, %1d). These must be (0, 1).",
3961 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003962 }
3963 }
3964
Dave Houlton33c2d252017-06-09 17:08:32 -06003965 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003966 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003967 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
3968 skip |= LogError(cb_node->commandBuffer, vuid,
3969 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003970 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04003971 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003972 }
3973 }
3974
Dave Houlton33c2d252017-06-09 17:08:32 -06003975 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003976 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3977 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003978 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003979 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
3980 skip |= LogError(cb_node->commandBuffer, vuid,
3981 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
3982 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003983 }
3984 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3985 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003986 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003987 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
3988 skip |= LogError(cb_node->commandBuffer, vuid,
3989 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
3990 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003991 }
3992 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3993 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003994 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003995 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
3996 skip |= LogError(cb_node->commandBuffer, vuid,
3997 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
3998 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003999 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004000 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004001 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
4002 skip |= LogError(cb_node->commandBuffer, vuid,
4003 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004004 }
4005
Dave Houlton33c2d252017-06-09 17:08:32 -06004006 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4007 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4008 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004009 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
4010 skip |= LogError(cb_node->commandBuffer, vuid,
4011 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4012 "layerCount other than 1.",
4013 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004014 }
4015 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004016 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004017 } else {
4018 assert(0);
4019 }
4020 return skip;
4021}
4022
Jeff Leger178b1e52020-10-05 12:22:23 -04004023bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4024 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4025 const VkImageBlit *pRegions, VkFilter filter) const {
4026 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4027 COPY_COMMAND_VERSION_1);
4028}
4029
4030bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4031 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4032 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4033 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4034}
4035
4036template <typename RegionType>
4037void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4038 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4039 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004040 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004041 auto src_image_state = GetImageState(srcImage);
4042 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004043
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004044 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004045 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004046 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4047 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004048 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004049}
4050
Jeff Leger178b1e52020-10-05 12:22:23 -04004051void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4052 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4053 const VkImageBlit *pRegions, VkFilter filter) {
4054 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4055 pRegions, filter);
4056 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4057}
4058
4059void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4060 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4061 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4062 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4063 pBlitImageInfo->filter);
4064}
4065
John Zulauf2076e812020-01-08 14:55:54 -07004066GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
4067 assert(map);
4068 // This approach allows for a single hash lookup or/create new
4069 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
4070 if (inserted.second) {
4071 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06004072 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004073 inserted.first->second.reset(layout_map);
4074 return layout_map;
4075 } else {
4076 assert(nullptr != inserted.first->second.get());
4077 return inserted.first->second.get();
4078 }
4079 return nullptr;
4080}
4081
4082const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4083 auto it = map.find(image);
4084 if (it != map.end()) {
4085 return it->second.get();
4086 }
4087 return nullptr;
4088}
4089
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004090// 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 -07004091bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
4092 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004093 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004094 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07004095 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06004096 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004097 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004098 for (const auto &layout_map_entry : pCB->image_layout_map) {
4099 const auto image = layout_map_entry.first;
4100 const auto *image_state = GetImageState(image);
4101 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004102 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07004103 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004104 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07004105 if (initial_layout_map.empty()) continue;
4106
4107 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
4108 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4109 if (global_map == nullptr) {
4110 global_map = &empty_map;
4111 }
4112
4113 // Note: don't know if it would matter
4114 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4115
4116 auto pos = initial_layout_map.begin();
4117 const auto end = initial_layout_map.end();
4118 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
4119 pos->first.begin);
4120 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07004121 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07004122 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07004123 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 -07004124 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004125 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004126 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004127 image_layout = current_layout->pos_B->lower_bound->second;
4128 }
4129 const auto intersected_range = pos->first & current_layout->range;
4130 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4131 // TODO: Set memory invalid which is in mem_tracker currently
4132 } else if (image_layout != initial_layout) {
4133 // Need to look up the inital layout *state* to get a bit more information
4134 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4135 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4136 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4137 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004138 // We can report all the errors for the intersected range directly
4139 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004140 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004141 skip |= LogError(
4142 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004143 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004144 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004145 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004146 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004147 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004148 }
4149 }
John Zulauf2076e812020-01-08 14:55:54 -07004150 if (pos->first.includes(intersected_range.end)) {
4151 current_layout.seek(intersected_range.end);
4152 } else {
4153 ++pos;
4154 if (pos != end) {
4155 current_layout.seek(pos->first.begin);
4156 }
4157 }
John Zulauff660ad62019-03-23 07:16:05 -06004158 }
4159
locke-lunargf155ccf2020-02-18 11:34:15 -07004160 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07004161 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004162 }
John Zulauff660ad62019-03-23 07:16:05 -06004163
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004164 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004165}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004166
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004167void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004168 for (const auto &layout_map_entry : pCB->image_layout_map) {
4169 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004170 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004171 const auto *image_state = GetImageState(image);
4172 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07004173 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
4174 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07004175 }
4176}
4177
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004178// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004179// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4180// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004181bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4182 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06004183 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004184 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004185 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4186
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004187 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004188 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4189 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004190 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004191 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4192 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4193 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004194 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004195 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004196 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004197 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4198 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4199 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004200 "vkCreateRenderPass(): 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) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4203 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004204 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004205 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004206 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004207 }
4208 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004209
4210 // Same as above for loadOp, but for stencilLoadOp
4211 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4212 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4213 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4214 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4215 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004216 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004217 string_VkImageLayout(first_layout));
4218 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4219 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4220 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004221 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004222 string_VkImageLayout(first_layout));
4223 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4224 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4225 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004226 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004227 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004228 }
4229 }
4230
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004231 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004232}
4233
Mark Lobodzinski96210742017-02-09 10:33:46 -07004234// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4235// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004236template <typename T1>
4237bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4238 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4239 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004240 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004241 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004242 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004243 if (strict) {
4244 correct_usage = ((actual & desired) == desired);
4245 } else {
4246 correct_usage = ((actual & desired) != 0);
4247 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004248
Mark Lobodzinski96210742017-02-09 10:33:46 -07004249 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004250 // All callers should have a valid VUID
4251 assert(msgCode != kVUIDUndefined);
4252 skip =
4253 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4254 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004255 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004256 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004257}
4258
4259// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4260// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004261bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004262 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004263 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004264 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004265}
4266
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004267bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004268 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004269 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004270 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4271 if ((image_format_features & desired) != desired) {
4272 // Same error, but more details if it was an AHB external format
4273 if (image_state->has_ahb_format == true) {
4274 skip |= LogError(image_state->image, vuid,
4275 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4276 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4277 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004278 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004279 } else {
4280 skip |= LogError(image_state->image, vuid,
4281 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4282 "with tiling %s.",
4283 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4284 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4285 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004286 }
4287 }
4288 return skip;
4289}
4290
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004291bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004292 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004293 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004294 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004295 // layerCount must not be zero
4296 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004297 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4298 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004299 }
4300 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004301 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004302 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4303 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004304 }
4305 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004306 if ((apsect_mask & VK_IMAGE_ASPECT_COLOR_BIT) && (apsect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004307 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4308 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4309 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4310 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004311 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004312 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4313 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4314 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
4315 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-02247",
4316 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4317 member);
4318 }
Cort Strattond619a302018-05-17 19:46:32 -07004319 return skip;
4320}
4321
Mark Lobodzinski96210742017-02-09 10:33:46 -07004322// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4323// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004324bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004325 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004326 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004327 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004328}
4329
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004330bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004331 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004332 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004333
4334 const VkDeviceSize &range = pCreateInfo->range;
4335 if (range != VK_WHOLE_SIZE) {
4336 // Range must be greater than 0
4337 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004338 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004339 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004340 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4341 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004342 }
4343 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004344 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4345 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004346 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004347 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004348 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4349 "(%" PRIu32 ").",
4350 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004351 }
4352 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004353 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004354 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004355 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004356 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4357 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4358 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004359 }
4360 // The sum of range and offset must be less than or equal to the size of buffer
4361 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004362 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004363 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004364 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4365 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4366 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004367 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004368 } else {
4369 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4370
4371 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4372 // VkPhysicalDeviceLimits::maxTexelBufferElements
4373 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4374 device_limits->maxTexelBufferElements) {
4375 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4376 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4377 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4378 "), divided by the element size of the format (%" PRIu32
4379 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4380 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4381 device_limits->maxTexelBufferElements);
4382 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004383 }
4384 return skip;
4385}
4386
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004387bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004388 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004389 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004390 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4391 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004392 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004393 "vkCreateBufferView(): If buffer was created with `usage` containing "
4394 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004395 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004396 }
4397 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4398 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004399 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004400 "vkCreateBufferView(): If buffer was created with `usage` containing "
4401 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004402 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004403 }
4404 return skip;
4405}
4406
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004407bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004408 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004409 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004410
Dave Houltond8ed0212018-05-16 17:18:24 -06004411 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004412
Jeff Bolz87697532019-01-11 22:54:00 -06004413 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4414 if (chained_devaddr_struct) {
4415 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4416 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004417 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4418 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4419 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004420 }
4421 }
4422
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004423 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4424 if (chained_opaqueaddr_struct) {
4425 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4426 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004427 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4428 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4429 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004430 }
4431 }
4432
Shannon McPherson4984e642019-12-05 13:04:34 -07004433 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004434 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4435 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004436 skip |= LogError(
4437 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004438 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4439 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4440 }
4441
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004442 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004443 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4444 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4445 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004446 }
4447
sfricke-samsungedce77a2020-07-03 22:35:13 -07004448 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4449 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4450 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4451 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4452 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4453 }
4454 const VkBufferCreateFlags invalid_flags =
4455 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4456 if ((pCreateInfo->flags & invalid_flags) != 0) {
4457 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4458 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4459 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4460 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4461 }
4462 }
4463
Mark Lobodzinski96210742017-02-09 10:33:46 -07004464 return skip;
4465}
4466
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004467bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004468 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004469 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004470 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004471 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4472 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004473 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004474 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4475 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004476 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004477 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4478 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4479 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004480
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004481 // Buffer view offset must be less than the size of buffer
4482 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004483 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004484 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004485 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4486 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004487 }
4488
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004489 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004490 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4491 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4492 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004493 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4494 : "VUID-VkBufferViewCreateInfo-offset-00926";
4495 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004496 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004497 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4498 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004499 }
4500
4501 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4502 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4503 if ((elementSize % 3) == 0) {
4504 elementSize /= 3;
4505 }
4506 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4507 VkDeviceSize alignmentRequirement =
4508 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4509 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
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-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004515 "vkCreateBufferView(): If buffer was created with usage containing "
4516 "VK_BUFFER_USAGE_STORAGE_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::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4520 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
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.storageTexelBufferOffsetAlignmentBytes,
4526 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4527 }
4528 }
4529 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4530 VkDeviceSize alignmentRequirement =
4531 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4532 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4533 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4534 }
4535 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004536 skip |= LogError(
4537 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004538 "vkCreateBufferView(): If buffer was created with usage containing "
4539 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004540 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4541 ") must be a multiple of the lesser of "
4542 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4543 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4544 "(%" PRId32
4545 ") is VK_TRUE, the size of a texel of the requested format. "
4546 "If the size of a texel is a multiple of three bytes, then the size of a "
4547 "single component of format is used instead",
4548 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4549 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4550 }
4551 }
4552 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004553
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004554 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004555
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004556 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004557 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004558 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004559}
4560
Mark Lobodzinski602de982017-02-09 11:01:33 -07004561// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004562bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004563 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004564 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004565 const IMAGE_STATE *image_state = GetImageState(image);
4566 // checks color format and (single-plane or non-disjoint)
4567 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004568 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004569 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004570 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 -07004571 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004572 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 -07004573 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004574 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004575 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004576 skip |= LogError(image, vuid,
4577 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4578 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4579 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004580 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004581 skip |= LogError(image, vuid,
4582 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4583 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4584 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004585 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004586 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004587 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004588 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 -07004589 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004590 skip |=
4591 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 -07004592 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004593 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004594 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004595 skip |=
4596 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 -07004597 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004598 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4599 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004600 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004601 } else if (FormatIsMultiplane(format)) {
4602 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4603 if (3 == FormatPlaneCount(format)) {
4604 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4605 }
4606 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004607 skip |=
4608 LogError(image, vuid,
4609 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4610 "set, where n = [0, 1, 2].",
4611 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004612 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004613 }
4614 return skip;
4615}
4616
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004617bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4618 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004619 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4620 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004621 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004622
4623 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004624 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004625 skip |= LogError(image, errorCodes.base_mip_err,
4626 "%s: %s.baseMipLevel (= %" PRIu32
4627 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4628 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004629 }
Petr Kraus4d718682017-05-18 03:38:41 +02004630
Petr Krausffa94af2017-08-08 21:46:02 +02004631 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4632 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004633 skip |=
4634 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004635 } else {
4636 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004637
Petr Krausffa94af2017-08-08 21:46:02 +02004638 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004639 skip |= LogError(image, errorCodes.mip_count_err,
4640 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4641 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4642 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4643 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004644 }
Petr Kraus4d718682017-05-18 03:38:41 +02004645 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004646 }
Petr Kraus4d718682017-05-18 03:38:41 +02004647
4648 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004649 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004650 skip |= LogError(image, errorCodes.base_layer_err,
4651 "%s: %s.baseArrayLayer (= %" PRIu32
4652 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4653 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004654 }
Petr Kraus4d718682017-05-18 03:38:41 +02004655
Petr Krausffa94af2017-08-08 21:46:02 +02004656 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4657 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004658 skip |=
4659 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004660 } else {
4661 const uint64_t necessary_layer_count =
4662 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004663
Petr Krausffa94af2017-08-08 21:46:02 +02004664 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004665 skip |= LogError(image, errorCodes.layer_count_err,
4666 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4667 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4668 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4669 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004670 }
Petr Kraus4d718682017-05-18 03:38:41 +02004671 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004672 }
Petr Kraus4d718682017-05-18 03:38:41 +02004673
Mark Lobodzinski602de982017-02-09 11:01:33 -07004674 return skip;
4675}
4676
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004677bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004678 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004679 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004680 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4681 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4682 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4683
4684 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4685 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4686
4687 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004688 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4689 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004690 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004691 : "VUID-VkImageViewCreateInfo-image-01482")
4692 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4693 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004694 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004695 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4696 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004697
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004698 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004699 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004700 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004701}
4702
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004703bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004704 const VkImageSubresourceRange &subresourceRange,
4705 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004706 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004707 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4708 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4709 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4710 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004711
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004712 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004713 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004714 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004715}
4716
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004717bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004718 const VkImageSubresourceRange &subresourceRange,
4719 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004720 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004721 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4722 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4723 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4724 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004725
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004726 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004727 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4728 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004729}
4730
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004731bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004732 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004733 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004734 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004735 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4736 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4737 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4738 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004739
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004740 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004741 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004742}
4743
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004744bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4745 const VkImageUsageFlags image_usage) const {
4746 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4747 bool skip = false;
4748
4749 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4750 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4751
4752 if (image_state->has_ahb_format == true) {
4753 // AHB image view and image share same feature sets
4754 tiling_features = image_state->format_features;
4755 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4756 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4757 assert(device_extensions.vk_ext_image_drm_format_modifier);
4758 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4759 nullptr};
4760 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4761
4762 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4763 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4764 nullptr};
4765 format_properties_2.pNext = (void *)&drm_properties_list;
4766 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4767
4768 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4769 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4770 0) {
4771 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4772 }
4773 }
4774 } else {
4775 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4776 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4777 : format_properties.optimalTilingFeatures;
4778 }
4779
4780 if (tiling_features == 0) {
4781 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4782 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4783 "physical device.",
4784 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4785 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4786 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4787 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4788 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4789 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4790 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4791 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4792 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4793 "VK_IMAGE_USAGE_STORAGE_BIT.",
4794 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4795 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4796 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4797 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4798 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4799 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4800 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4801 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4802 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4803 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4804 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4805 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4806 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4807 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4808 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4809 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4810 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4811 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4812 }
4813
4814 return skip;
4815}
4816
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004817bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004818 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004819 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004820 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004821 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004822 skip |=
4823 ValidateImageUsageFlags(image_state,
4824 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4825 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07004826 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
4827 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4828 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004829 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07004830 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004831 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004832 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004833 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004834 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004835 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004836 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004837
4838 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4839 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004840 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004841 VkFormat view_format = pCreateInfo->format;
4842 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004843 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004844 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004845
Dave Houltonbd2e2622018-04-10 16:41:14 -06004846 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004847 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004848 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004849 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004850 if (!device_extensions.vk_ext_separate_stencil_usage) {
4851 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004852 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4853 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4854 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004855 }
4856 } else {
4857 const auto image_stencil_struct =
4858 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4859 if (image_stencil_struct == nullptr) {
4860 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004861 skip |= LogError(
4862 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004863 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4864 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4865 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4866 }
4867 } else {
4868 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4869 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4870 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004871 skip |= LogError(
4872 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004873 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4874 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4875 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4876 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4877 }
4878 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4879 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004880 skip |= LogError(
4881 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004882 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4883 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4884 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4885 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4886 }
4887 }
4888 }
4889 }
4890
Dave Houltonbd2e2622018-04-10 16:41:14 -06004891 image_usage = chained_ivuci_struct->usage;
4892 }
4893
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004894 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4895 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004896 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004897 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004898 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004899 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004900 std::stringstream ss;
4901 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004902 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004903 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004904 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004905 }
4906 } else {
Nathaniel Cesario0046c312020-10-07 23:28:28 -06004907 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004908 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4909 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004910 const char *error_vuid;
4911 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4912 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4913 } else if ((device_extensions.vk_khr_maintenance2) &&
4914 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4915 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4916 } else if ((!device_extensions.vk_khr_maintenance2) &&
4917 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4918 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4919 } else {
4920 // both enabled
4921 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4922 }
Dave Houltonc7988072018-04-16 11:46:56 -06004923 std::stringstream ss;
4924 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004925 << " is not in the same format compatibility class as "
4926 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004927 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4928 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004929 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004930 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004931 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004932 }
4933 } else {
4934 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004935 // Unless it is a multi-planar color bit aspect
4936 if ((image_format != view_format) &&
4937 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4938 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4939 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004940 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004941 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004942 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004943 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004944 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004945 }
4946 }
4947
4948 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004949 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004950
4951 switch (image_type) {
4952 case VK_IMAGE_TYPE_1D:
4953 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004954 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4955 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4956 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004957 }
4958 break;
4959 case VK_IMAGE_TYPE_2D:
4960 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4961 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4962 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004963 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
4964 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4965 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004966 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004967 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4968 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4969 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004970 }
4971 }
4972 break;
4973 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004974 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004975 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4976 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4977 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004978 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004979 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
4980 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4981 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004982 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4983 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004984 skip |= LogError(
4985 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4986 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4987 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
4988 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4989 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004990 }
4991 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004992 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4993 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4994 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004995 }
4996 }
4997 } else {
4998 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004999 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5000 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5001 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005002 }
5003 }
5004 break;
5005 default:
5006 break;
5007 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005008
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005009 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005010 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005011 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005012 }
5013
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005014 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005015
Jeff Bolz9af91c52018-09-01 21:53:57 -05005016 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5017 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005018 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5019 "vkCreateImageView() If image was created with usage containing "
5020 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
5021 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005022 }
5023 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005024 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5025 "vkCreateImageView() If image was created with usage containing "
5026 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005027 }
5028 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005029
5030 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5031 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5032 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5033 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5034 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5035 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5036 }
5037 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5038 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5039 skip |= LogError(
5040 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5041 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5042 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5043 }
5044 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005045
5046 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5047 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005048 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005049 "vkCreateImageView(): If image was created with usage containing "
5050 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5051 pCreateInfo->subresourceRange.levelCount);
5052 }
5053 }
5054 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5055 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005056 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005057 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5058 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5059 }
5060 } else {
5061 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5062 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5063 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005064 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005065 "vkCreateImageView(): If image was created with usage containing "
5066 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5067 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5068 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5069 }
5070 }
5071 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005072
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005073 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5074 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5075 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5076 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5077 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5078 }
5079 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5080 skip |=
5081 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5082 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5083 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5084 }
5085 }
5086 if (device_extensions.vk_ext_fragment_density_map_2) {
5087 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5088 (pCreateInfo->subresourceRange.layerCount >
5089 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5090 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5091 "vkCreateImageView(): If image was created with flags containing "
5092 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5093 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5094 pCreateInfo->subresourceRange.layerCount,
5095 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5096 }
5097 }
5098
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005099 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
5100 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5101 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5102 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5103 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5104 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5105 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5106 }
5107 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005108 }
5109 return skip;
5110}
5111
Jeff Leger178b1e52020-10-05 12:22:23 -04005112template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005113bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005114 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005115 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005116 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5117 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5118 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005119
5120 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5121 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5122 VkDeviceSize src_min = UINT64_MAX;
5123 VkDeviceSize src_max = 0;
5124 VkDeviceSize dst_min = UINT64_MAX;
5125 VkDeviceSize dst_max = 0;
5126
5127 for (uint32_t i = 0; i < regionCount; i++) {
5128 src_min = std::min(src_min, pRegions[i].srcOffset);
5129 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5130 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5131 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5132
5133 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5134 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005135 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
5136 skip |= LogError(src_buffer_state->buffer, vuid,
5137 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5138 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005139 }
5140
5141 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5142 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005143 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
5144 skip |= LogError(dst_buffer_state->buffer, vuid,
5145 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5146 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005147 }
5148
5149 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5150 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005151 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
5152 skip |= LogError(src_buffer_state->buffer, vuid,
5153 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005154 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005155 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005156 }
5157
5158 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5159 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005160 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
5161 skip |= LogError(dst_buffer_state->buffer, vuid,
5162 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005163 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005164 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005165 }
5166 }
5167
5168 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5169 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5170 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005171 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
5172 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
5173 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005174 }
5175 }
5176
5177 return skip;
5178}
5179
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005180bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005181 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005182 const auto cb_node = GetCBState(commandBuffer);
5183 const auto src_buffer_state = GetBufferState(srcBuffer);
5184 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005185
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005186 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005187 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5188 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005189 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005190 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005191 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5192 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005193 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005194 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5195 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005196 skip |=
5197 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5198 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005199 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5200 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Jeff Leger178b1e52020-10-05 12:22:23 -04005201 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07005202 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5203 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5204 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005205 return skip;
5206}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005207
Jeff Leger178b1e52020-10-05 12:22:23 -04005208bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
5209 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
5210 const auto cb_node = GetCBState(commandBuffer);
5211 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
5212 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
5213
5214 bool skip = false;
5215 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
5216 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
5217 // Validate that SRC & DST buffers have correct usage flags set
5218 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
5219 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
5220 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5221 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
5222 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
5223 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
5224 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer2KHR()",
5225 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5226 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-cmdpool");
5227 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
5228 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-renderpass");
5229 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
5230 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
5231 skip |=
5232 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
5233 skip |=
5234 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
5235 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
5236 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
5237 return skip;
5238}
5239
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005240bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005241 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005242 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005243 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005244 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005245 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5246 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005247 }
5248 }
5249 return skip;
5250}
5251
Jeff Bolz5c801d12019-10-09 10:38:45 -05005252bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5253 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005254 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005255 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005256
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005257 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005258 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005259 skip |=
5260 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005261 }
5262 return skip;
5263}
5264
Jeff Bolz5c801d12019-10-09 10:38:45 -05005265bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005266 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005267
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005268 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005269 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005270 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005271 }
5272 return skip;
5273}
5274
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005275bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005276 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005277 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005278 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005279 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005280 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005281 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005282 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005283 }
5284 return skip;
5285}
5286
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005287bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005288 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005289 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005290 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005291 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005292 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005293 skip |=
5294 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5295 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005296 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005297 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005298 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5299 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005300 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005301
sfricke-samsung022fa252020-07-24 03:26:16 -07005302 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5303 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5304
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005305 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005306 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5307 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5308 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5309 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005310 }
5311
5312 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005313 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5314 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5315 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5316 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005317 }
5318
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005319 return skip;
5320}
5321
Jeff Leger178b1e52020-10-05 12:22:23 -04005322template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07005323bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005324 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
5325 const char *function, CopyCommandVersion version) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005326 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005327 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5328 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04005329
sfricke-samsung125d2b42020-05-28 06:32:43 -07005330 assert(image_state != nullptr);
5331 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005332
5333 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005334 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005335 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5336 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005337 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-srcImage-00199",
5338 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5339 "and 1, respectively.",
5340 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005341 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005342 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005343
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005344 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5345 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005346 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-srcImage-00201",
Jeff Leger178b1e52020-10-05 12:22:23 -04005347 "%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 -07005348 "must be 0 and 1, respectively.",
5349 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005350 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005351 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005352
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005353 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5354 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005355 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
Jeff Leger178b1e52020-10-05 12:22:23 -04005356 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005357 "For 3D images these must be 0 and 1, respectively.",
5358 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005359 }
5360 }
5361
5362 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005363 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005364 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005365
sfricke-samsung125d2b42020-05-28 06:32:43 -07005366 // If not depth/stencil and not multi-plane
5367 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5368 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005369 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-bufferOffset-01558"
5370 : "VUID-vkCmdCopyBufferToImage-bufferOffset-00193";
sfricke-samsung125d2b42020-05-28 06:32:43 -07005371 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005372 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005373 " must be a multiple of this format's texel size (%" PRIu32 ").",
5374 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005375 }
5376
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005377 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5378 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005379 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005380 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferRowLength-00195",
Jeff Leger178b1e52020-10-05 12:22:23 -04005381 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005382 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005383 }
5384
5385 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5386 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005387 skip |=
5388 LogError(image_state->image, "VUID-VkBufferImageCopy-bufferImageHeight-00196",
5389 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5390 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005391 }
5392
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005393 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005394 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005395 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005396 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 -06005397 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5398 static_cast<int32_t>(adjusted_image_extent.width))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005399 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00197",
Jeff Leger178b1e52020-10-05 12:22:23 -04005400 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005401 "zero or <= image subresource width (%d).",
5402 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005403 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005404 }
5405
5406 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005407 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 -06005408 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5409 static_cast<int32_t>(adjusted_image_extent.height))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005410 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00198",
Jeff Leger178b1e52020-10-05 12:22:23 -04005411 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005412 "zero or <= image subresource height (%d).",
5413 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005414 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005415 }
5416
5417 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005418 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 -06005419 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5420 static_cast<int32_t>(adjusted_image_extent.depth))) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005421 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
Jeff Leger178b1e52020-10-05 12:22:23 -04005422 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005423 "zero or <= image subresource depth (%d).",
5424 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005425 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005426 }
5427
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005428 // subresource aspectMask must have exactly 1 bit set
5429 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005430 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005431 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005432 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
5433 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005434 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005435 }
5436
5437 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005438 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005439 skip |=
5440 LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
5441 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5442 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005443 }
5444
5445 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005446 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5447 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005448
5449 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005450 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005451 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203"
5452 : "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203";
Jeff Leger178b1e52020-10-05 12:22:23 -04005453 skip |=
5454 LogError(image_state->image, vuid,
5455 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5456 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005457 }
5458
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005459 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005460 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005461 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204"
5462 : "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005463 skip |= LogError(
sfricke-samsung3a10b922020-05-13 23:23:16 -07005464 image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005465 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005466 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005467 }
5468
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005469 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005470 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5471 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5472 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005473 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-imageOffset-00205"
5474 : "VUID-vkCmdCopyBufferToImage-imageOffset-00205";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005475 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005476 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005477 "width & height (%d, %d)..",
5478 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5479 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005480 }
5481
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005482 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005483 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005484 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005485 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-bufferOffset-00206"
5486 : "VUID-vkCmdCopyBufferToImage-bufferOffset-00206";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005487 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005488 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005489 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5490 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005491 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005492
5493 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005494 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005495 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005496 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005497 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-imageExtent-00207"
5498 : "VUID-vkCmdCopyBufferToImage-imageExtent-00207";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005499 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005500 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005501 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5502 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5503 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005504 }
5505
5506 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005507 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005508 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005509 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-imageExtent-00208"
5510 : "VUID-vkCmdCopyBufferToImage-imageExtent-00208";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005511 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005512 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005513 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5514 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5515 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005516 }
5517
5518 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005519 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005520 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005521 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-vkCmdCopyBufferToImage-imageExtent-00209"
5522 : "VUID-vkCmdCopyBufferToImage-imageExtent-00209";
sfricke-samsung3a10b922020-05-13 23:23:16 -07005523 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005524 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005525 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5526 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5527 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005528 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005529 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005530
5531 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005532 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005533 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005534 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005535 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
Jeff Leger178b1e52020-10-05 12:22:23 -04005536 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005537 "format has three planes.",
5538 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005539 }
5540
5541 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005542 if (0 ==
5543 (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 -06005544 skip |= LogError(image_state->image, "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
Jeff Leger178b1e52020-10-05 12:22:23 -04005545 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005546 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5547 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005548 } else {
5549 // Know aspect mask is valid
5550 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5551 const uint32_t compatible_size = FormatElementSize(compatible_format);
5552 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5553 skip |= LogError(
Shannon McPherson2c793ba2020-08-28 12:13:24 -06005554 image_state->image, "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
Jeff Leger178b1e52020-10-05 12:22:23 -04005555 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07005556 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5557 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5558 string_VkFormat(compatible_format));
5559 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005560 }
5561 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005562 }
5563
5564 return skip;
5565}
5566
Jeff Leger178b1e52020-10-05 12:22:23 -04005567template <typename BufferImageCopyRegionType>
5568bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
5569 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005570 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005571 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005572
5573 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005574 VkExtent3D extent = pRegions[i].imageExtent;
5575 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005576
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005577 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5578 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005579 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5580 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5581 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005582 }
5583
5584 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5585
5586 // 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 -06005587 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005588 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005589 if (image_extent.width % block_extent.width) {
5590 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5591 }
5592 if (image_extent.height % block_extent.height) {
5593 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5594 }
5595 if (image_extent.depth % block_extent.depth) {
5596 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5597 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005598 }
5599
Dave Houltonfc1a4052017-04-27 14:32:45 -06005600 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005601 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005602 }
5603 }
5604
5605 return skip;
5606}
5607
Jeff Leger178b1e52020-10-05 12:22:23 -04005608template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005609bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005610 const BufferImageCopyRegionType *pRegions, const char *func_name,
5611 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005612 bool skip = false;
5613
5614 VkDeviceSize buffer_size = buff_state->createInfo.size;
5615
5616 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005617 VkDeviceSize max_buffer_offset =
5618 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5619 if (buffer_size < max_buffer_offset) {
5620 skip |=
5621 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 -07005622 }
5623 }
5624
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005625 return skip;
5626}
5627
Jeff Leger178b1e52020-10-05 12:22:23 -04005628template <typename BufferImageCopyRegionType>
5629bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5630 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
5631 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005632 const auto cb_node = GetCBState(commandBuffer);
5633 const auto src_image_state = GetImageState(srcImage);
5634 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005635
Jeff Leger178b1e52020-10-05 12:22:23 -04005636 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5637 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
5638 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
5639 const char *vuid;
5640
5641 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005642
5643 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005644 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005645
5646 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005647 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005648
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005649 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005650
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005651 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005652 vuid =
5653 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
5654 skip |= LogError(cb_node->createInfo.commandPool, vuid,
5655 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
5656 "or transfer capabilities.",
5657 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005658 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005659 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
5660 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
5661 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
5662 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005663
Jeff Leger178b1e52020-10-05 12:22:23 -04005664 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
5665 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
5666 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5667
5668 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
5669 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
5670 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
5671 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005672
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005673 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04005674 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
5675 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005676 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005677 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
5678 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005679 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005680 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
5681 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
5682 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
5683 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
5684 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
5685 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005686
5687 // Validation for VK_EXT_fragment_density_map
5688 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005689 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
5690 skip |= LogError(cb_node->commandBuffer, vuid,
5691 "%s: srcImage must not have been created with flags containing "
5692 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5693 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005694 }
5695
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005696 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005697 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
5698 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005699 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005700 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer-renderpass" : "VUID-vkCmdCopyImageToBuffer-renderpass";
5701 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005702 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005703
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005704 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 -04005705 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
5706 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
5707 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
5708 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
5709
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005710 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005711 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5712 vuid =
5713 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005714 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005715 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
5716 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
5717 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
5718 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
5719 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
5720 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5721 "imageSubresource", vuid);
5722 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
5723 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005724 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005725 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005726 }
5727 return skip;
5728}
5729
Jeff Leger178b1e52020-10-05 12:22:23 -04005730bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5731 VkBuffer dstBuffer, uint32_t regionCount,
5732 const VkBufferImageCopy *pRegions) const {
5733 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
5734 COPY_COMMAND_VERSION_1);
5735}
5736
5737bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5738 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
5739 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
5740 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
5741 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
5742}
5743
John Zulauf1686f232019-07-09 16:27:11 -06005744void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5745 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5746 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5747
5748 auto cb_node = GetCBState(commandBuffer);
5749 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005750 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005751 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005752 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005753 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005754}
5755
Jeff Leger178b1e52020-10-05 12:22:23 -04005756void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5757 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
5758 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
5759
5760 auto cb_node = GetCBState(commandBuffer);
5761 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
5762 // Make sure that all image slices record referenced layout
5763 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
5764 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
5765 pCopyImageToBufferInfo->srcImageLayout);
5766 }
5767}
5768
5769template <typename RegionType>
5770bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5771 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
5772 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005773 const auto cb_node = GetCBState(commandBuffer);
5774 const auto src_buffer_state = GetBufferState(srcBuffer);
5775 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005776
Jeff Leger178b1e52020-10-05 12:22:23 -04005777 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5778 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
5779 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
5780 const char *vuid;
5781
5782 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005783
5784 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005785 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005786
sfricke-samsungea4fd142020-10-17 23:51:59 -07005787 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool";
5788 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
5789
Jeff Leger178b1e52020-10-05 12:22:23 -04005790 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
5791 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
5792 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
5793 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
5794
5795 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
5796 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
5797 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5798 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
5799 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
5800 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
5801 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
5802 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
5803 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005804 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005805 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
5806 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005807 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005808 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
5809 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
5810 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
5811 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
5812 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
5813 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005814
5815 // Validation for VK_EXT_fragment_density_map
5816 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005817 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
5818 skip |= LogError(cb_node->commandBuffer, vuid,
5819 "%s: dstImage must not have been created with flags containing "
5820 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5821 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005822 }
5823
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005824 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005825 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
5826 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005827 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005828 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-renderpass" : "VUID-vkCmdCopyBufferToImage-renderpass";
5829 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005830 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005831
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005832 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 -04005833 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
5834 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
5835 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
5836 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
5837
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005838 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005839 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5840 vuid =
5841 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005842 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005843 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
5844 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
5845 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
5846 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
5847 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
5848 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5849 "imageSubresource", vuid);
5850 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
5851 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005852 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005853 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07005854
5855 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
5856 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
5857 assert(command_pool != nullptr);
5858 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
5859 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
5860 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
5861 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
5862 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
5863 LogObjectList objlist(cb_node->commandBuffer);
5864 objlist.add(command_pool->commandPool);
5865 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
5866 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
5867 skip |= LogError(dst_image_state->image, vuid,
5868 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
5869 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
5870 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
5871 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
5872 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
5873 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005874 }
5875 return skip;
5876}
5877
Jeff Leger178b1e52020-10-05 12:22:23 -04005878bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5879 VkImageLayout dstImageLayout, uint32_t regionCount,
5880 const VkBufferImageCopy *pRegions) const {
5881 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
5882 COPY_COMMAND_VERSION_1);
5883}
5884
5885bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
5886 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
5887 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
5888 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
5889 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
5890}
5891
John Zulauf1686f232019-07-09 16:27:11 -06005892void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5893 VkImageLayout dstImageLayout, uint32_t regionCount,
5894 const VkBufferImageCopy *pRegions) {
5895 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5896
5897 auto cb_node = GetCBState(commandBuffer);
5898 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005899 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005900 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005901 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005902 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005903}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005904
Jeff Leger178b1e52020-10-05 12:22:23 -04005905void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
5906 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
5907 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
5908
5909 auto cb_node = GetCBState(commandBuffer);
5910 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
5911 // Make sure that all image slices are record referenced layout
5912 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
5913 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
5914 pCopyBufferToImageInfo2KHR->dstImageLayout);
5915 }
5916}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005917bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005918 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005919 bool skip = false;
5920 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5921
Dave Houlton1d960ff2018-01-19 12:17:05 -07005922 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005923 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5924 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5925 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005926 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5927 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005928 }
5929
John Zulaufa26d3c82019-08-14 16:09:08 -06005930 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005931 if (!image_entry) {
5932 return skip;
5933 }
5934
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005935 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5936 if (device_extensions.vk_ext_image_drm_format_modifier) {
5937 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5938 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005939 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5940 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5941 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005942 }
5943 } else {
5944 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005945 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5946 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005947 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005948 }
5949
Dave Houlton1d960ff2018-01-19 12:17:05 -07005950 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005951 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005952 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5953 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5954 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005955 }
5956
Dave Houlton1d960ff2018-01-19 12:17:05 -07005957 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005958 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005959 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5960 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5961 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005962 }
5963
Dave Houlton1d960ff2018-01-19 12:17:05 -07005964 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005965 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005966 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5967 if (FormatIsMultiplane(img_format)) {
5968 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5969 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5970 if (FormatPlaneCount(img_format) > 2u) {
5971 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5972 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5973 }
5974 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005975 skip |= LogError(image, vuid,
5976 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5977 ") must be a single-plane specifier flag.",
5978 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005979 }
5980 } else if (FormatIsColor(img_format)) {
5981 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005982 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
5983 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5984 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005985 }
5986 } else if (FormatIsDepthOrStencil(img_format)) {
5987 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5988 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005989 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005990 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5991 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5992 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5993 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005994 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
5995 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5996 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005997 }
5998 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005999
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006000 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006001 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006002 }
6003
Mike Weiblen672b58b2017-02-21 14:32:53 -07006004 return skip;
6005}
sfricke-samsung022fa252020-07-24 03:26:16 -07006006
6007// Validates the image is allowed to be protected
6008bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
6009 const char *vuid) const {
6010 bool skip = false;
6011 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6012 LogObjectList objlist(cb_state->commandBuffer);
6013 objlist.add(image_state->image);
6014 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while image %s is a protected image", cmd_name,
6015 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6016 report_data->FormatHandle(image_state->image).c_str());
6017 }
6018 return skip;
6019}
6020
6021// Validates the image is allowed to be unprotected
6022bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
6023 const char *vuid) const {
6024 bool skip = false;
6025 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6026 LogObjectList objlist(cb_state->commandBuffer);
6027 objlist.add(image_state->image);
6028 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while image %s is an unprotected image", cmd_name,
6029 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6030 report_data->FormatHandle(image_state->image).c_str());
6031 }
6032 return skip;
6033}
6034
6035// Validates the buffer is allowed to be protected
6036bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
6037 const char *vuid) const {
6038 bool skip = false;
6039 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6040 LogObjectList objlist(cb_state->commandBuffer);
6041 objlist.add(buffer_state->buffer);
6042 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while buffer %s is a protected buffer", cmd_name,
6043 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6044 report_data->FormatHandle(buffer_state->buffer).c_str());
6045 }
6046 return skip;
6047}
6048
6049// Validates the buffer is allowed to be unprotected
6050bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
6051 const char *vuid) const {
6052 bool skip = false;
6053 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6054 LogObjectList objlist(cb_state->commandBuffer);
6055 objlist.add(buffer_state->buffer);
6056 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while buffer %s is an unprotected buffer", cmd_name,
6057 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
6058 report_data->FormatHandle(buffer_state->buffer).c_str());
6059 }
6060 return skip;
6061}